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.
- Host: GitHub
- URL: https://github.com/geekyharsh05/typescript-rest-api
- Owner: geekyharsh05
- Created: 2023-09-27T17:10:33.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-27T17:24:04.000Z (almost 3 years ago)
- Last Synced: 2025-10-26T13:43:37.039Z (8 months ago)
- Topics: crud-api, express, mongodb, rest-api, typescript
- Language: TypeScript
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
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.