https://github.com/pablosilvab/crossfit-wod-api
REST API Design Best Practices Handbook – How to Build a REST API with JavaScript, Node.js, and Express.js
https://github.com/pablosilvab/crossfit-wod-api
express mongodb nodejs redis
Last synced: 2 months ago
JSON representation
REST API Design Best Practices Handbook – How to Build a REST API with JavaScript, Node.js, and Express.js
- Host: GitHub
- URL: https://github.com/pablosilvab/crossfit-wod-api
- Owner: pablosilvab
- License: gpl-3.0
- Created: 2022-07-21T23:35:57.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-03T12:52:43.000Z (over 2 years ago)
- Last Synced: 2025-01-10T21:21:19.703Z (4 months ago)
- Topics: express, mongodb, nodejs, redis
- Language: JavaScript
- Homepage:
- Size: 206 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
# Crossfit-wod-api
REST API Design Best Practices Handbook – How to Build a REST API with JavaScript, Node.js, and Express.js
Based in: https://www.freecodecamp.org/news/rest-api-design-best-practices-build-a-rest-api/
## Tools
[![Node][node.js]][node-url]
[![Express][express.js]][express-url]
[![MongoDB][mongodb]][mongodb-url]
[![Heroku][heroku]][heroku-url]
[![Redis][redis]][redis-url]
## Requirements
- Node.js
- npm
- MongoDB (I use Docker container for local development)
- Redis (I use Docker container for local development)
## Installing
Install dependencies
```
npm install
```
Run MongoDB and Redis locally
```
docker-compose up -d
```
## Executing
Run application with
```
npm run dev
```
[contributors-shield]: https://img.shields.io/github/contributors/pablosilvab/crossfit-wod-api.svg?style=for-the-badge
[contributors-url]: https://github.com/pablosilvab/crossfit-wod-api/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/pablosilvab/crossfit-wod-api.svg?style=for-the-badge
[forks-url]: https://github.com/pablosilvab/crossfit-wod-api/network/members
[stars-shield]: https://img.shields.io/github/stars/pablosilvab/crossfit-wod-api.svg?style=for-the-badge
[stars-url]: https://github.com/pablosilvab/crossfit-wod-api/stargazers
[issues-shield]: https://img.shields.io/github/issues/pablosilvab/crossfit-wod-api.svg?style=for-the-badge
[issues-url]: https://github.com/pablosilvab/crossfit-wod-api/issues
[license-shield]: https://img.shields.io/github/license/pablosilvab/crossfit-wod-api.svg?style=for-the-badge
[license-url]: https://github.com/pablosilvab/crossfit-wod-api/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=blue
[linkedin-url]: https://linkedin.com/in/pablosilvab
[node.js]: https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white
[node-url]: https://nodejs.org/es/
[express.js]: https://img.shields.io/badge/Express.js-404D59?style=for-the-badge
[express-url]: http://expressjs.com/
[mongodb]: https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white
[mongodb-url]: https://www.mongodb.com/
[heroku]: https://img.shields.io/badge/Heroku-430098?style=for-the-badge&logo=heroku&logoColor=white
[heroku-url]: https://www.heroku.com/
[redis]: https://img.shields.io/badge/redis-%23DD0031.svg?&style=for-the-badge&logo=redis&logoColor=white
[redis-url]: https://redis.io/