Merge pull request #42 from FlipTask/staging

Staging

Author: dev-ashishk

.env.example

@@ -0,0 +1,24 @@
+PORT=
+HOST_URL=
+SECRET=
+LOG_DIR=./logs
+
+# Database 
+DB_TYPE=
+DB_HOST=
+DB_PORT=
+DB_USERNAME=
+DB_PASSWORD=
+DB_NAME=
+
+# Email
+MAILER_USERNAME=
+MAILER_PASSWORD=
+MAILER_SERVICE_NAME=
+MAILER_SENDER_EMAIL=
+MAILER_HOST=
+
+# Google Auth
+GOOGLE_CLIENT_ID=
+GOOGLE_CLIENT_SECRET=
+GOOGLE_CALLBACK_URL=/user/auth/google/callback

.gitignore

@@ -6,4 +6,5 @@
 /upload/*.jpg
 /upload/*.png
 /upload/*.jpeg
-/env/dev.env
+.env
+.vscode

README.md

@@ -15,19 +15,19 @@ Steps to follow
 1.  Clone Fliptask-API
 2.  Change the current directory to `fliptask-api`.
 ```
-cd tasify
+cd fliptask-api
 ```
-3. Run the install script `install.sh`
+3. Copy `.env.example` as `.env`, make required changes.
+
+4. Run the install script `install.sh`
 ```
 bash ./install.sh
 ```
-4. To start the server run:
+5. To start the server run:
 ```
 npm run dev 
 ```
 
-> open <http://localhost:3000> in browser.
-
 ### Possible Errors and its solutions
 If get any `error` in running `install.sh`,  example : 
 ```

env/dev.env

@@ -1,11 +1,3 @@
 #!/bin/bash
 
-printf "\n------------ Installing Dependencies ----------------\n\n"
-
-npm install;
-
-printf "\n------------ Rebuilding bcrypt package --------------\n\n"
-
-npm rebuild bcrypt --build-from-source;
-
-printf "\n--------- Run (npm run dev) to start server ---------\n\n"
+npm ci;