universities-monitor: A TypeScript repository from m4theuspereira-maker

Description

That's a simple solution to start APIs in nodejs if you don't want to download all dependencies every time when you start some new project.

You can implement any architecture on this template and it already comes with prettier, jest, eslint, docker and suport for circleci if you wanna implement CI/CD in that platform.

Basics

The template comes by default with some basic commands, for example:

To build project and add husky configuration

(to know more about husky: https://typicode.github.io/husky/#/)

$ yarn build

Or if you wanna just create .husky folder with pre-push and pre-commit files

$ yarn prepare

To start project from dist folder

$ yarn start

To start project from src folder with nodemon

(to know more about nodemon: https://nodemon.io/)

$ yarn dev

Run all the test suits

$ yarn test

Select wich suit you wanna run in watch mode or related files uncommited by git

(know more in: https://jestjs.io/docs/cli)

$ yarn test:watch

Run all the tests and generate bunch of informations about project test coverage

$ yarn test:coverage

To start project from docker container

(know more in: https://docs.docker.com/get-started/ and https://docs.docker.com/compose/gettingstarted/)

$ docker-compose up

Project folders schema

universities-monitor
├─ .circleci
│  └─ config.yml
├─ .editorconfig
├─ .eslintignore
├─ .eslintrc.json
├─ .gitignore
├─ .prettierrc.json
├─ Dockerfile
├─ README.md
├─ docker-compose.yml
├─ jest.config.js
├─ nodemon.json
├─ package.json
├─ src
│  ├─ config
│  │  ├─ environment-consts.ts
│  │  └─ swagger.json
│  ├─ controllers
│  │  ├─ handlers
│  │  │  └─ handlers.ts
│  │  ├─ university-controller.ts
│  │  └─ user-controller.ts
│  ├─ factories
│  │  ├─ controller-factories.ts
│  │  ├─ middlewares-factory.ts
│  │  └─ service-factories.ts
│  ├─ index.ts
│  ├─ infra
│  │  ├─ errors
│  │  │  └─ erros.ts
│  │  └─ reposiroties
│  │     ├─ interfaces
│  │     │  └─ repository-interfaces.ts
│  │     ├─ university-repository.ts
│  │     └─ user-repository.ts
│  ├─ middlewares
│  │  └─ authentication-middlewares.ts
│  ├─ routes.ts
│  └─ services
│     ├─ adapters
│     │  └─ adapters.ts
│     ├─ encryption-services.ts
│     ├─ schedule-services.ts
│     ├─ university-services.ts
│     └─ user-services.ts
├─ tests
│  ├─ config
│  │  ├─ mocks
│  │  └─ teste-config
│  └─ infra
├─ tsconfig-build.json
├─ tsconfig.json
├─ yarn-error.log
└─ yarn.lock

Basic usage

If you wanna tests endpoints you have get the authentication token. To get token may start application and access the address YOUR_LOCALHOST:ENV_FILE_PORT/api. After see swagger home page, access users tags and create an new user.