https://github.com/galib-23/node-typescript
This repository includes all the necessary boilerplate to start backend with Node.js and Typescript
https://github.com/galib-23/node-typescript
Last synced: 3 months ago
JSON representation
This repository includes all the necessary boilerplate to start backend with Node.js and Typescript
- Host: GitHub
- URL: https://github.com/galib-23/node-typescript
- Owner: Galib-23
- Created: 2024-06-04T05:50:41.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-07T06:18:56.000Z (12 months ago)
- Last Synced: 2025-01-11T05:25:30.559Z (5 months ago)
- Language: TypeScript
- Size: 71.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Creating a Node.js server with Express and Typescript
***1.** First run this command to initiate the **package.json** file*
```
npm init -y
```
***2.** Now configure the **tsconfig.json** file as like this:*
```javascript
{
"compilerOptions": {
"module": "NodeNext",
"moduleResolution": "NodeNext",
"baseUrl": "src",
"outDir": "dist",
"sourceMap": true,
"noImplicitAny": true,
},
"include": ["src/**/*"]
}
```
***3.** Configure the **nodemon.json** file for constantly watching the ./src/index.ts file*
```json
{
"watch": ["src"],
"ext": ".ts, .js",
"exec": "ts-node ./src/index.ts"
}
```
***4.** Install the following dependencies*
```bash
npm i -D express body-parser cookie-parser compression cors
```
***5.** Install the types for the dependencies*
```bash
npm i -D @types/express @types/body-parser @types/cookie-parser @types/compression @types/cors
```
***6.** Create **src** folder and inside create file named **index.ts** for the entry point of server.*
### body-parser vs express :
Previously we used body-parser for parsing body data from request. But now it is a part of express. So, rather using:
```typescript
app.use(bodyParser.json());
```
we can simply use:
```typescript
app.use(express.json());
```
***7.** Now Let's install **mongoose** for schema validation for mongoDB*
```bash
npm i mongoose
```
***8.** Now Let's go to mongoDB and create a free cluster and copy the connection string. Then put the connection string in .env*
***9.** Connect to the database using mongoose:*
```typescript
mongoose.Promise = Promise;
mongoose.connect(process.env.MONGO_URL);
mongoose.connection.on('error', (error: Error) => {
console.log(error)
})
```
***10.** Create the schema for various collection*
***11.** Finally Create the necessary helpers and routes as required*