kopia lustrzana https://github.com/reiver/greatape
docs(project): 📝 update readme
rodzic
0223f92645
commit
b7cfb2e4d3
66
README.md
66
README.md
|
@ -15,25 +15,69 @@
|
|||
|
||||
### 🚀 Using Go and Postgres
|
||||
|
||||
1. Clone the project repository: `git clone https://github.com/reiver/greatape`
|
||||
2. Navigate to the project directory: `cd greatape`
|
||||
1. Clone the project repository:
|
||||
```
|
||||
git clone https://github.com/reiver/greatape
|
||||
```
|
||||
2. Navigate to the project directory:
|
||||
```
|
||||
cd greatape
|
||||
```
|
||||
3. Create an empty Postgres database.
|
||||
4. Update the `config.yaml` file in the project root directory with the actual values for your database.
|
||||
5. Download the project dependencies: `go mod download`
|
||||
6. Run the project: `go run main.go`
|
||||
5. Download the project dependencies:
|
||||
```
|
||||
go mod download
|
||||
```
|
||||
6. Run the project:
|
||||
```
|
||||
go run main.go
|
||||
```
|
||||
|
||||
### 🐳 Using Docker
|
||||
|
||||
1. Clone the project repository: `git clone https://github.com/reiver/greatape`
|
||||
2. Navigate to the project directory: `cd greatape`
|
||||
3. Build the Docker image: `docker build -t greatape .`
|
||||
4. Replace the environment variables below with your own and run the Docker container: `docker run --name greatape -e PROTOCOL=https -e FQDN=yourdomain.com -e PORT=7080 -e POSTGRES_HOST=127.0.0.1 -e POSTGRES_PORT=5432 -e POSTGRES_DATABASE=greatape -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=password -p 7080:7080 greatape`
|
||||
1. Clone the project repository:
|
||||
```
|
||||
git clone https://github.com/reiver/greatape
|
||||
```
|
||||
2. Navigate to the project directory:
|
||||
```
|
||||
cd greatape
|
||||
```
|
||||
3. Build the Docker image:
|
||||
```
|
||||
docker build -t greatape .
|
||||
```
|
||||
4. Replace the environment variables below with your own and run the Docker container:
|
||||
```
|
||||
docker run \
|
||||
--name greatape \
|
||||
-e PROTOCOL=https \
|
||||
-e FQDN=yourdomain.com \
|
||||
-e PORT=7080 \
|
||||
-e POSTGRES_HOST=127.0.0.1 \
|
||||
-e POSTGRES_PORT=5432 \
|
||||
-e POSTGRES_DATABASE=greatape \
|
||||
-e POSTGRES_USER=postgres \
|
||||
-e POSTGRES_PASSWORD=password \
|
||||
-p 7080:7080 \
|
||||
greatape
|
||||
```
|
||||
|
||||
### 🐳 Using docker-compose
|
||||
|
||||
1. Clone the project repository: `git clone https://github.com/reiver/greatape`
|
||||
2. Navigate to the project directory: `cd greatape`
|
||||
3. Run the Docker containers using docker-compose: `docker-compose up`
|
||||
1. Clone the project repository:
|
||||
```
|
||||
git clone https://github.com/reiver/greatape
|
||||
```
|
||||
2. Navigate to the project directory:
|
||||
```
|
||||
cd greatape
|
||||
```
|
||||
3. Run the Docker containers using docker-compose:
|
||||
```
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
## 👥 Team
|
||||
|
||||
|
|
Ładowanie…
Reference in New Issue