Skip to content

christianodejesus/sample-api-typescript

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sample API - TypeScript

Sample project made with NodeJS and TypeScript. This project servs as a starting point to build a RestAPI with these technologies.

Key technologies

  • [NodeJS] NodeJS
  • [TypeScript] TypeScript
  • [KoaJS] KoaJS Web Framework
  • [MongoDB] MongoDB database

Installation

Download or clone API source code and follow above steps

Using Npm

$ npm install
$ npm run setup:env # This will setup an .env file with the environment variables
$ npm run dev # This will run the API for development

Using Yarn

$ yarn
$ yarn setup:dev # This will setup an .env file with the environment variables
$ yarn dev # This will run the API for development