An open API service indexing awesome lists of open source software.

https://github.com/geekyharsh05/typescript-rest-api

This is a simple CRUD API built using Express.js, MongoDB & Typescript.
https://github.com/geekyharsh05/typescript-rest-api

crud-api express mongodb rest-api typescript

Last synced: 3 months ago
JSON representation

This is a simple CRUD API built using Express.js, MongoDB & Typescript.

Awesome Lists containing this project

README

          

# Typescript Rest API

This API is built using **Node.js** and **Express.js**, and it utilizes **MongoDB** as the database.

## 🚀 Getting Started

## :bulb: Requirements

Before you begin, ensure you have met the following requirements:

- Node.js
- MongoDB
- Typescript
- An understanding of RESTful API concepts

## ⬇️ Installation

- Clone the repository
- Install the dependencies
- Fill the necessary environment variables (see .env.example)
- Run the server

```bash
git git@github.com:geekyharsh05/Typescript-REST-API.git
cd Typescript-REST-API
npm install
npm run dev
```

## 📝 Configuration

You can configure the API by setting environment variables in the `.env` file. Be sure to provide the necessary database connection URI, port.