Node Structure

This repository is created a reference for node project structure.

Prerequisite

• Nodejs

How to Run

git clone [email protected]:endrureza/node-structure.git
cd node-structure
yarn install
yarn dev

Application Structure

/app

All API logic, model relation and middleware should go to this folder

/config

All configuration regarding application should go to this folder

/database

All migration script and seeder go to this folder

/jobs

All job or queue script go to this folder

/routes

All endpoint or routing should go to this folder

/services

All third party services configuration or setting should go to this folder

/tests

All test mechanism should go to this folder

/utils

All imported library that is not exposed to outside of package should go to this folder

app.js

This file must be included in server.js to run as it provides all activity for fastify and for testing purpose too.

server.js

This file will be the main to execute / run application

apidoc.json

All route documentation should go to this file

Authors

• Endru Reza (Linkedin)