vinisaveg/clean-node-app

An API with Nodejs, Typescript, TDD, Clean Architecture, Design Patterns, SOLID and more.

clean-node-app

An API with Nodejs, Typescript, TDD, Clean Architecture, Design Patterns, SOLID and more...

Installing 👷

Clone this repo:

git clone https://github.com/vinisaveg/clean-node-app.git

Install dependencies:

yarn install

Setup 🔧

Create a .env file with the following environment vars:

MONGO_INITDB_ROOT_USERNAME=
MONGO_INITDB_ROOT_PASSWORD=

ME_CONFIG_MONGODB_URL=mongodb://USERNAME:PASSWORD@mongodb:27017/
ME_CONFIG_MONGODB_ADMINUSERNAME=
ME_CONFIG_MONGODB_ADMINPASSWORD=

MONGODB_URI=mongodb://USERNAME:PASSWORD@localhost:27017/DBNAME?authSource=admin
MONGODB_TEST_URI=mongodb://USERNAME:PASSWORD@localhost:27017/DBNAME?authSource=admin

JWT_SECRET=
JWT_ALGORITHM=

Run the database containers:

yarn up

Running 🏃

Development mode:

yarn dev

Build the application:

yarn build

Run build application:

yarn start

Testing 🚨

Running the tests:

yarn test

Development ⚙️

Configuring husky and git hooks

npx husky install