From 077e1bb98306b2a995ac141706b51fb5b596863b Mon Sep 17 00:00:00 2001 From: Alif Naufal Date: Tue, 19 Apr 2022 23:12:42 +0700 Subject: [PATCH] update readme --- .gitignore | 4 +++- README.md | 16 ++++++++++++++++ src/.env | 4 ++-- src/.env.example | 14 ++++++++++++++ 4 files changed, 35 insertions(+), 3 deletions(-) create mode 100644 src/.env.example diff --git a/.gitignore b/.gitignore index 5741cc3..fa31026 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ docker-compose-deploy.yml gits-smart.json -sma-rt-firebase-adminsdk.json \ No newline at end of file +sma-rt-firebase-adminsdk.json + +.env \ No newline at end of file diff --git a/README.md b/README.md index 33acc2d..82560b8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # gits-capstone-project +Before you run this project, you need to install the requirement: +- Golang +- Docker/Postgresql (chose one) + +
+ +## Docker Section +if you use docker, you can run this command for running the database +``` +docker-compose -f database.yml up -d +``` +after that, you can run this command for running the service +``` +docker-compose up -d +``` + [![Deploy VPS](https://github.com/alifnaufalyasin/gits-capstone-project/actions/workflows/deploy-vps.yml/badge.svg?branch=master&event=workflow_run)](https://github.com/alifnaufalyasin/gits-capstone-project/actions/workflows/deploy-vps.yml) diff --git a/src/.env b/src/.env index 9365590..a8a7542 100644 --- a/src/.env +++ b/src/.env @@ -10,5 +10,5 @@ RESET_TABLES=true SEED_TABLES=true EMAIL=design.aliven7@gmail.com -PASSWORD_EMAIL= -FIREBASE_API_KEY= \ No newline at end of file +PASSWORD_EMAIL=jfhrxbvhepngnbsv +FIREBASE_API_KEY=AAAAPB7DZ3k:APA91bEdWRKIYHYVwxqHtW_fWxnX01kLZOMxGglwhDi4SN1XU8Uth9j05f6bXS-l-kVVPNjdSXxpX96EKEDALroaUd5yPKJNcp6B4cRVNPT8PiCE3oNLvRmG-iKN5DW-rKtsYGj8hWsi \ No newline at end of file diff --git a/src/.env.example b/src/.env.example new file mode 100644 index 0000000..83a5503 --- /dev/null +++ b/src/.env.example @@ -0,0 +1,14 @@ +DB_HOST=localhost +DB_PORT=5432 +DB_USERNAME=postgres +DB_PASSWORD=postgres +DB_NAME=postgres +PORT= +SECRET= + +RESET_TABLES= +SEED_TABLES= + +EMAIL= +PASSWORD_EMAIL= +FIREBASE_API_KEY= \ No newline at end of file