fastify-mongo-boilerplate

Deploy a Node.js server very quickly with Fastify and MongoDB.

File structure

• 📁 dist/
• 📁 node_modules/
• 📂 src/
  • 📁 controllers/
  • 📂 types/
    • 📄 index.type.ts
  • 📂 routes/
    • 📄 index.route.ts
  • 📂 services/
    • 📄 index.service.ts
    • 📄 aws.service.ts
    • 📄 emailer.service.ts
    • 📄 fastify.service.ts
    • 📄 firebase.service.ts
    • 📄 redis.service.ts
    • 📄 mongo.service.ts
  • 📄 index.ts
• 📄 example.env
• 📄 package.json
• 📄 postman.json
• 📄 README.md
• 📄 tsconfig.json
• 📄 yarn.lock

Run

First of all, install typescript and nodemon gobally with yarn.

1. At the repository root, download the dependencies with yarn:

yarn

2. Rename the file example.env to .env, and edit the environment variables. Some of them are required when using Fastify and TypeORM as JWT_SECRET,SERVER_PORT and MONGO_ ones.

3. Make sure you're running your database service. Create your collection types in types/index.type.ts.

4. Add aditional services at index.ts services array, if necessary.

5. Add aditional *.route.ts files into index.route.ts routes array, if necessary.

6. Run tsc -w at project root directory.

7. Additionally, run nodemon at dist/ directory.

8. Edit src/ TypeScript code with automatic reload!