/saturn-service

Saturn Service is an API specially developed for financial institutions, offering you the possibility to record all your monthly earnings and expenses in a simple and practical way.

Primary LanguageTypeScript

Release Coverage Status typescript nodejs npm

Saturn Service (User API)

Saturn Service is a API used for user creation and authentication. Where you can create, update and fetch user data. It is part of a project aimed at creating portfolios for financial control wallet.

Stacks

  • Design Patterns
    • Factory Method
    • Adapter
    • Composite
    • Builder
  • Express
  • Bcrypt
  • JWT
  • MongoDB
  • Nodemon
  • Jest
  • Eslint

Installation

cp example.env .env
npm install

Running the Application with node

npm run start
npm run start:dev

Running the Application with debug

npm run start:debug

Running the Application with docker

docker compose up

API Routes

All routes run on port 3001 but you can change it in .env file

  • Sign Up: {{host}}/api/sign-up
  • Sign In: {{host}}/api/sign-in
  • Get User: {{host}}/api/user auth
  • Get All Users: {{host}}/api/users auth
  • Update User: {{host}}/api/user auth
  • Confirm User: {{host}}/api/user/confirm auth
  • Redefine password: {{host}}/api/user/redefine-password auth

Running tests

# Running all test
npm run test

# Unit test
npm run test:unit

# Integration test
npm run test:e2e

# Running all test with coverage
npm run test:ci

# Running all test and show errors
npm run test:verbose