Giter VIP home page Giter VIP logo

node-typescript-api's Introduction

Library Book API

Stacks: TypeScript, Express, PostgresSQL, PrismaORM, Jest.

Endpoints: With swagger-autogen all endpoints will be available at your_api_url/api-docs.

Configuration

Set up the env file based on the .env.example.

Installation

$ npm install
$ docker compose up --build -d

Running the app

Development

$ npm run dev

Unit tests

$ npm run test

Architecture:

Controller

  • src/controllers/: Create the controller to handle the business logic

Exceptions

  • src/exceptions: HTTP exceptions

Interfaces

  • src/interfaces: Entities interface

Middlewares

  • src/middlewares: Helps validate data and errors handling between requisitions.

Repositories

  • src/repositories: Queries to the database (CRUD)

Routes

  • src/routes: Our endpoints paths

Tests:

  • src/tests: Entities test

node-typescript-api's People

Contributors

rgoncalvss avatar

Stargazers

 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.