Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jsamuelap/crossfit-wod-api

REST API for a CrossFit Training Application
https://github.com/jsamuelap/crossfit-wod-api

apicache crossfit-wod express express-validator fl0 freecodecamp jsonwebtoken jwt node nodejs rest-api swagger swagger-ui workout

Last synced: 25 days ago
JSON representation

REST API for a CrossFit Training Application

Awesome Lists containing this project

README

        

# CrossFit WOD API

## Description 🏝️

**REST API** for a CrossFit Training Application. This API was designed in this article of [freeCodeCamp](https://www.freecodecamp.org/news/rest-api-design-best-practices-build-a-rest-api/). This API provides CRUDs for workouts, records and members.

### Technologies 🤖

- [Node.js](https://nodejs.org/es)
- [JWT](https://jwt.io/)
- [Swagger](https://swagger.io/)

### Packages 📦

- [Express](https://www.npmjs.com/package/express)
- [Apicache](https://www.npmjs.com/package/apicache)
- [DotEnv](https://www.npmjs.com/package/dotenv)
- [Express-validator](https://express-validator.github.io/docs)
- [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken)
- [swagger-ui-express](https://www.npmjs.com/package/swagger-ui-express)

## Autor ✒️

**JSamuel**

- [LinkeIn](https://www.linkedin.com/in/jsamuelap/)
- [Twitter](https://twitter.com/JSamuelAP)
- [GitHub](https://github.com/JSamuelAP)
- [Portfolio 💼](https://jsamuelap.github.io/)
- [Email 📧](mailto:[email protected])

## Watch online 👀

Coming soon: react app that will use this API.
Documentation: [Swagger UI](https://crossfit-wod-api-dev-eegs.1.us-1.fl0.io/api/v1/docs/)

## Instalation 💻

```bash
npm install
npm run dev
```

You must first log in on `/api/v1/auth` and you can use the endpoints.