Skip to content

Commit 0ebf053

Browse files
committed
doc: README file
1 parent bb6e1ed commit 0ebf053

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Project Name
1+
# Backend Template for TypeScript, Express and Mongoose
22

33
This is a template project for backend development using Typescript, Node.js, Express, Mongoose, Bcrypt, JWT, NodeMailer, Multer, ESLint, and Prettier. The aim is to reduce setup time for new backend projects.
44

@@ -70,13 +70,12 @@ Ensure you have the following installed:
7070
In the root directory of the project, create a `.env` file and add the following variables. Adjust the values according to your setup.
7171

7272
```env
73-
# Basic
74-
SERVER_NAME=project_name
73+
SERVER_NAME=template
7574
NODE_ENV=development
76-
DATABASE_URL=mongodb://127.0.0.1:27017/project_name
75+
DATABASE_URL=mongodb://127.0.0.1:27017/template
7776
IP_ADDRESS=10.10.7.7
78-
PORT=5000 // for production after build (`npm start`)
79-
PORT_DEV=5001 // for development (`npm run dev`)
77+
PORT=5000 # for production after build (`npm start`)
78+
PORT_DEV=5001 # for development (`npm run dev`)
8079
8180
# Bcrypt
8281
BCRYPT_SALT_ROUNDS=12
@@ -86,7 +85,7 @@ Ensure you have the following installed:
8685
JWT_EXPIRE_IN=1d
8786
8887
# Email
89-
EMAIL_FROM=your_email@gmail.com
88+
EMAIL_FROM=your_company_email@gmail.com
9089
EMAIL_USER=your_email@gmail.com
9190
EMAIL_PASS=mkqcfjeqloothyax
9291
EMAIL_PORT=587

0 commit comments

Comments
 (0)