Skip to content

This is the API starter. It is a REST API built with Node.js, Express.js, and MongoDB.

License

Notifications You must be signed in to change notification settings

Fillonit/express-ts-mongo

Repository files navigation

express typescript starter with mongodb

This is the API starter. It is a REST API built with Node.js, Express.js, and MongoDB.

Getting Started

To get started, clone this repository and run npm install to install the dependencies. Then, run npm start to start the server. The server will be running on port 8080.

API Documentation

The API documentation can be found here.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Technologies Used

TypeScript JavaScript NodeJS Express.js Nodemon MongoDB

Authors

Installation

Clone

Clone this repository to your local machine using

$ git clone

Setup

Install npm packages

$ npm install

Create a .env file in the root directory and add the following

NODE_ENV=
MONGO_USERNAME=
MONGO_PASSWORD=
MONGO_URL=
SECRET=
APP_OWNER_ID=
RIOT_API_KEY=
PORT=

Run the server

$ npm start

Run the server with nodemon

$ npm run dev

Run the tests

$ npm test

About

This is the API starter. It is a REST API built with Node.js, Express.js, and MongoDB.

Topics

Resources

License

Stars

Watchers

Forks