Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/renatozr/car-dealership-api
An API that handles vehicle data from a car dealership
https://github.com/renatozr/car-dealership-api
expressjs mongoose oop swagger typescript unit-testing zod
Last synced: about 2 months ago
JSON representation
An API that handles vehicle data from a car dealership
- Host: GitHub
- URL: https://github.com/renatozr/car-dealership-api
- Owner: renatozr
- Created: 2024-08-15T02:01:22.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-16T03:11:25.000Z (4 months ago)
- Last Synced: 2024-08-17T03:25:24.350Z (4 months ago)
- Topics: expressjs, mongoose, oop, swagger, typescript, unit-testing, zod
- Language: TypeScript
- Homepage: https://car-dealership-api-qqe5.onrender.com/documentation
- Size: 82 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Car Dealership API
An API that handles vehicle data from a car dealership
View Demo
(the free deploy spins down with inactivity, which can delay requests by 50 seconds or more)
## About The Project
To exercise RESTful API development, unit testing, OOP and documentation with Swagger.
## Getting Started
### Prerequisites
- NPM
- MongoDB
### Installation
1. Clone the repo
```sh
git clone [email protected]:renatozr/car-dealership-api.git
```
2. Enter the directory
```sh
cd car-dealership-api
```
3. Install NPM packages
```sh
npm install
```
4. Rename .env.example file to .env
5. Fill in the environment variables (example below)
```sh
PORT=3001
MONGODB_URI=mongodb://localhost:27017/CarDealership
SERVER_URL=http://localhost:3001
```
6. Run the project
```sh
npm run dev
```
7. Run the project tests
```sh
npm run test
```