Code Monkey home page Code Monkey logo

api's Introduction

Authorization and Authentication API

An authentication and authorization API

Tech Stack

  • Node JS (TypeScript)
  • Postgres
  • Sequelize (ORM)
  • Swagger Docs

Running Locally

Requirements

  • Docker
  • Docker-compose
  • Sequelize CLI (>=v6.6.2)
  • Make

Create ENV file

cp .example.env .env

Example ENV values

PG_USER=scanwize
PG_PASSWORD=scanwize
PG_DB=scanwize
PG_HOST=pgdb # name of docker container running the db
JWT_SECRET=secret
JWT_EXPIRY=30
SALT_ROUNDS=10

Start services

docker-compose up

Run migrations

make migrate

Generate seed data

make seed

Create an account

To create an account use the register route as per the API docs

N/B: Seed data generates two roles: Admin and User. When creating an account, use the Roles route to determine the respective roleIDs to be used during registration

Services can be accessed on:

API - http://localhost:3000/api/v1

Docs - http://localhost:7050

api's People

Contributors

edwinwalela avatar

Watchers

 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.