Update README.md

This commit is contained in:
Kaushik Narayan R 2022-11-12 09:18:22 +00:00
parent 60cb9813ab
commit 501e43d51d

View File

@ -1,13 +1,16 @@
# Express-Sequelize backend server template # Express-Sequelize backend server template
### 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/ctf-tech-2023/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/ctf-tech-2023/new-repo-name`
- Remove the template environment files from git alone: `git rm -r --cached *.env*`
### Project setup: ### Project setup:
- Edit `package.json` to reflect the new name and URLs - Edit `package.json` to reflect the new name and URLs
- Edit `README.md` to reflect project details
- 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: