From 5b3b36ba31aeeac3014e52f256a71bd7b5958fbd Mon Sep 17 00:00:00 2001 From: I Kadek Yuda Budipratama Giri <13516115@std.stei.itb.ac.id> Date: Thu, 21 Mar 2019 13:47:30 +0700 Subject: [PATCH] Added readme for backend --- backend/.env.example | 2 +- backend/README.md | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 backend/README.md diff --git a/backend/.env.example b/backend/.env.example index 3d508ff..d5b517c 100644 --- a/backend/.env.example +++ b/backend/.env.example @@ -2,6 +2,6 @@ PORT=8081 DB_USERNAME = "postgres" DB_HOST = "localhost" -DB_NAME = "postgres" +DB_NAME = "jabar_innov_monev_2" DB_PASSWORD = "hue" DB_PORT = "5432" \ No newline at end of file diff --git a/backend/README.md b/backend/README.md new file mode 100644 index 0000000..3ab5e4f --- /dev/null +++ b/backend/README.md @@ -0,0 +1,24 @@ +## Install and Running: +1. Copy ```.env.example``` to ```.env``` +2. Replace ```.env``` values according to your environment +3. Run +``` +npm install +``` +4. To start backend server, run +``` +npm start +``` +5. Do work. Any changes in the backend will be automatically updated. No more turning the server on and off again! :) +6. Good luck have fun! + +## Guides on .env +``` +PORT = <port-number> // 8081 default. Do not change unless you changed it on front end as well + +DB_USERNAME = < username in PostgreSQL > +DB_HOST = < location of host. Leave it at localhost for local development > +DB_NAME = < database name > +DB_PASSWORD = < your password according to db username > +DB_PORT = < db port number. Leave it as 5432 unless it's different on your db > +``` \ No newline at end of file -- GitLab