/typescript-crm-api

Primary LanguageTypeScript

Basic REST API using Typescript and MongoDB

This is a basic REST API built using Node.js, TypeScript, and MongoDB. The API includes endpoints for getting all customers, getting a single customer, and creating a new customer.

Getting Started

To get started with this API, follow these steps:

  1. Clone the repository to your local machine.
  2. Install the necessary dependencies by running npm install in the project directory.
  3. Start the API by running npm start in the project directory.

API Endpoints

  • GET /customers - Returns a list of all customers.
  • GET /customers/:id - Returns the customer with the specified id.
  • POST /customers - Creates a new customer.

Technologies Used

  • Node.js
  • TypeScript
  • MongoDB

License

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

Acknowledgments

  • This API was built following the tutorial found in the video "How to build a REST API with TypeScript & MongoDB" by Tom Shaw.