Giter Club home page Giter Club logo

api_jwt's Introduction

API JWT

API to learn some techs

Project   |    Techs   |    How to use   |   

CircleCI

Codecov

Code Climate maintainability

Project

Preview

Structure

  ├── .circleci
  ├── build 
  ├── coverage
  ├── src
│   ├── components
│   │   ├── login
│   │   ├── logout
│   │   └── user
│   ├── config
│   │   ├── constants
│   │   └── redis
│   ├── database
│   │   └── migrations
│   ├── environments
│   ├── exceptions
│   ├── handlers
│   ├── helpers
│   ├── middlewares
│   └── utils
  • .circleci: CI configuration

  • build: the build files

  • coverage: test coverage

  • src: application source

  • src/components: the project separates by components each component has its route, controller, test and others in the same directory

  • src/config: application config (redis, database, etc)

  • src/database: the migrations files

  • src/environments: the variable settings for each environment (development, test, production)

  • src/exceptions: the application custom exceptions

  • src/handlers: handlers files

  • src/helpers: files with some methods to help

  • src/middlewares: application middlewares

  • src/utils: utility functions or class

Techs

How to Use

Clone the repository

 git clone https://github.com/eduahcb/api_jwt.git

 cd api_jwt

Install Dependencies

 
  yarn install

Run development mode

Before you run this command you need to create a .env file like .env.example. You can choose the connection (mysql, postgres, mssql), host, etc, then you need to run the migrations:

  yarn typeorm migration:run
 yarn dev

Run with docker

docker-compose up -d

BaseUrl Ports and API documentation

  baseUrl: "/api/v1"
  
  port: "localhost:8080"
  
  api documentation: "/api/v1/doc"

Tests

 yarn test

Coverage

 yarn cov

Build

  yarn build

api_jwt's People

Contributors

eduahcb avatar

Stargazers

 avatar  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.