Code Monkey home page Code Monkey logo

express-ts-mongodb's Introduction

typescript-rest-api



REST API built in TS + Express + MongoDB

The Blog app example, contains JWT Auth and Mongoose ODM for MongoDB.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Usage

A step by step series of examples that tell you how to get a development env running, Say what the step will be :

  1. Copy and rename .env.example to .env and configure your enviroment
  2. Run $ yarn
  3. Run $ yarn build:watch
  4. RUn $ yarn dev
  5. Open Postman/ Insomnia to test API

The Route User Manajemen & Auth :

Method EndPoint Description
POST /api/v1/auth/signin User Auth
POST /api/v1/auth/signup User Register
GET /api/v1/user/Profile User Profile

The Route Topic Manajemen :

Method EndPoint Description
GET /api/v1/topics Show All Topics
POST /api/v1/topics Store New Topic
GET /api/v1/topics/:id Show Topic
PUT /api/v1/topics/:id Update Topic
DELETE /api/v1/topics/:id Delete Topic

The Route Article Manajemen :

Method EndPoint Description
GET /api/v1/articles Show All Articles
POST /api/v1/articles Store New Article
GET /api/v1/articles/:id Show Article
PUT /api/v1/articles/:id Update Article
DELETE /api/v1/articles/:id Delete Article
Filter ?filter_field Field filter, ex: status
Filter ?filter_value Value filter, ex: draft, deleted, published
Filter ?topic Topic filter, ex: sci-fi, crime, adventure
Sort ?sort_field Sort field, ex: title, createdBy
Sort ?sort_orientation Sort orientation, ex: asc & desc

Authors

  • Sebastianus Sembara - Initial work - ssembara

See also the list of contributors who participated in this project.

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.