https://github.com/felipeclarindo/car-hub-api
Api in NestJS and typescript for the car-hub project
https://github.com/felipeclarindo/car-hub-api
api api-development api-rest nestjs typescript
Last synced: 4 months ago
JSON representation
Api in NestJS and typescript for the car-hub project
- Host: GitHub
- URL: https://github.com/felipeclarindo/car-hub-api
- Owner: felipeclarindo
- License: agpl-3.0
- Created: 2025-01-06T16:36:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-19T21:36:02.000Z (about 1 year ago)
- Last Synced: 2025-02-07T14:41:39.105Z (12 months ago)
- Topics: api, api-development, api-rest, nestjs, typescript
- Language: TypeScript
- Homepage:
- Size: 117 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🌍 [Leia em Português](README.pt-BR.md)
# Car Hub Api
Api to the car hub project developed with `NestJS` and `typescript`.
## Technologies Used
- `NestJS` - Frameworks to create apis.
- `typescript` - JS Superset.
## Api Endpoints
- `/api` - description of the api. (GET)
- `/api/fuels` - Fuels available to cars. (GET)
- `/api/manufacturers` - Manufacturers of cars. (GET)
- `/api/footer-links` - footer links to use in front end. (GET)
- `/api/years-of-production` - Cars year of production. (GET)
## Running Api
1. Clone the Repository:
```bash
git clone https://github.com/felipeclarindo/car-hub-api.git
```
2. Install Dependencies :
```bash
npm install
```
3. Run Server:
```bash
npm run start
```
4. Access API in http://localhost:5000/api.
5. Access [CarHub Repository](https://github.com/felipeclarindo/car-hub.git) and run the front end.
## Contribution
Contributions are welcome! If you have suggestions for improvements, feel free to open an issue or submit a pull request.
## Author
**Felipe Clarindo**
- [LinkedIn](https://www.linkedin.com/in/felipeclarindo)
- [Instagram](https://www.instagram.com/lipethecoder)
- [GitHub](https://github.com/felipeclarindo)
## License
This project is licensed under the [GNU Affero License](https://www.gnu.org/licenses/agpl-3.0.html).