Giter Club home page Giter Club logo

saturn-service's Introduction

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

saturn-service's People

Contributors

renatops1991 avatar

Stargazers

Luka Rocha avatar

Watchers

 avatar Kostas Georgiou avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.