Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cybermaxi7/exercise-api
https://github.com/cybermaxi7/exercise-api
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/cybermaxi7/exercise-api
- Owner: Cybermaxi7
- Created: 2023-12-12T14:02:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-19T11:32:07.000Z (about 1 year ago)
- Last Synced: 2023-12-19T15:57:57.423Z (about 1 year ago)
- Language: JavaScript
- Size: 2.51 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Exercise API
## Overview
The exercise API provides information about exercises, body parts, and targets. Users can retrieve details about specific exercises, explore different body parts, and identify targeted muscle groups.
## Features
- **Exercise Retrieval:** Retrieve information about specific exercises.
- **Body Parts:** Explore information about different body parts.
- **Targets:** Identify muscle groups targeted by exercises.
- **Exercise Name:** Search for exercises based on partial or exact matches of exercise names.
## Getting Started
### Prerequisites
Make sure you have Node.js and npm installed on your machine.
### Installation
1. Clone this repository:
```bash
git clone https://github.com/cybermaxi7/exercise-api.git
```
2. Navigate to the project directory:
```bash
cd exercise-api
```
3. Install dependencies:
```bash
npm install
```
### Usage
Start the JSON Server with the following command:
```bash
npm start
```
This will launch the API server, and you can then make requests to the available endpoints.
## API Endpoints
- **Retrieve Exercise by ID:**
```
GET /exercises/:id
```
- **Search for Exercises:**
```
GET /exercises?name=:searchTerm
```
- **Retrieve Body Parts:**
```
GET /bodyParts
```
- **Retrieve Targets:**
```
GET /targets
```
## Examples
### Retrieve Exercise by ID
```bash
curl http://localhost:3000/exercises/1
```
### Search for Exercises
```bash
curl http://localhost:3000/exercises?name=push
```
## Contributing
If you would like to contribute to this project, please follow the guidelines outlined in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
For questions or feedback, please contact Cybermaxi at [email protected]
Feel free to use and modify this template as needed for your project.