ShogunIsHere/express-sequelize-backend-template
1
0
Fork 0
mirror of https://github.com/20kaushik02/express-sequelize-backend-template.git synced 2025-12-06 09:34:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md before going public

Browse Source
This commit is contained in:
Kaushik Narayan R 2023-09-21 16:43:06 -07:00 committed by GitHub
parent 62ed623c7e
commit ba4a4e1fcd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -2,9 +2,9 @@
### To get started: ### To get started:
- Clone this repo: `git clone https://gitlab.com/ctf-tech-2023/backend-template` - Clone this repo: `git clone https://gitlab.com/20kaushik02/express-sequelize-backend-template`
- Reset the git remote repo URL: `git remote rm origin` - Reset the git remote repo URL: `git remote rm origin`
- Set new git remote URL: `git remote add origin https://gitlab.com/ctf-tech-2023/new-repo-name` - Set new git remote URL: `git remote add origin https://gitlab.com/20kaushik02/new-repo-name`
- Remove the template environment files from git alone: `git rm -r --cached *.env*` - Remove the template environment files from git alone: `git rm -r --cached *.env*`
### Project setup: ### Project setup:
@ -14,8 +14,8 @@
- Run `npm i` to install all dependencies - Run `npm i` to install all dependencies
- Before running `sequelize-cli` commands while developing, make sure to set `$env:NODE_ENV='development'` on Windows, or `NODE_ENV=development` on Linux/MacOS - Before running `sequelize-cli` commands while developing, make sure to set `$env:NODE_ENV='development'` on Windows, or `NODE_ENV=development` on Linux/MacOS
- Env config: - Env config:
- **.env** - All things common to all environments (port, mailer creds, JWT secret, admin data access creds, etc.) - **.env** - All things common to all environments (port, etc.)
- **.env.development** - Development environment (dev captcha secret, dev DB details) - **.env.development** - Development environment (dev captcha secret, mailer creds, JWT secret, dev DB details, dev admin data access creds)
- **.env.staging** - Staging environment (dev captcha secret, staging DB conn. string) - **for sysadmins** - **.env.staging** - Staging environment (dev captcha secret, mailer creds, JWT secret, staging DB conn. string, staging admin data access creds) - **for sysadmins**
- **.env.production** - Production environment (production captcha secret, prod DB conn. string) - **for sysadmins** - **.env.production** - Production environment (production captcha secret, mailer creds, JWT secret, prod DB conn. string, production admin data access creds) - **for sysadmins**
- Staging: `npm run staging_prep` and `npm run staging` to deploy on Render after configuring a new web service on Render dashboard - Staging: `npm run staging_prep` and `npm run staging` to deploy on Render after configuring a new web service on Render dashboard