https://github.com/charmingdc/quoteapi
A simple, serverless API that serves mood categorized quotes.
https://github.com/charmingdc/quoteapi
Last synced: over 1 year ago
JSON representation
A simple, serverless API that serves mood categorized quotes.
- Host: GitHub
- URL: https://github.com/charmingdc/quoteapi
- Owner: Charmingdc
- License: mit
- Created: 2024-11-13T10:15:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-03T06:53:04.000Z (over 1 year ago)
- Last Synced: 2025-01-03T07:35:02.650Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://quote-api-ashen.vercel.app/api/quotes
- Size: 79.1 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quote API
A simple, serverless API that serves mood categorized quotes. The quotes are available in JSON format and are stored in a `.json` file. This API is deployed on Vercel and can be accessed from the endpoint below.
## Currently supported categories
- Anger
- Courage
- Failure
- Health
- Jealousy
- Love
- Patience
- Relationship
- Respect
- Sad
- Smile
- Strength
- Success
- Faith
- Inspirational
- Thankful
- Truth
- Wisdom
- Motivational
- Life
- Morning
- Uplifting
- Stressed
- Anxious
- Calm
- gratitude
## API Endpoint
You can access the quotes by making a `GET` request to:
```
https://quote-api-ashen.vercel.app/api/quotes
```
## How to Use
1. **GET Request**:
Call the API with a standard GET request to fetch the list of quotes.
Example:
```bash
curl https://quote-api-ashen.vercel.app/api/quotes
```
The response will be a JSON of object of arrays of quotes.
2. **Response Format**:
The API will return a JSON response containing objects of arrays of quotes.
Example response:
```json
{
"moods": {
"anger": [
"Anger is one letter short of danger.",
"The best way to deal with anger is to not let it control you.",
"Anger is a wind which blows out the lamp of the mind.",
"He who angers you conquers you.",
"Don’t let anger consume you.",
"Anger is a temporary madness.",
],
"courage": [
"Courage is not the absence of fear, but the triumph over it.",
"Fear is a reaction. Courage is a decision.",
"Courage is grace under pressure.",
"The only courage that matters is the kind that gets you from one moment to the next.",
"Courage is not the absence of fear, but the willingness to face it.",
"It takes courage to grow up and become who you really are.",
"Courage is being scared to death, but saddling up anyway.",
]
}
}
```
## How to Contribute
1. Fork this repository.
2. Add or edit quotes in the `quotes.json` file.
3. Create a pull request.
## Local Development
To run the API locally:
1. Clone the repo:
```bash
git clone https://github.com/Charmingdc/QuoteApi.git
cd QuoteApi
```
2. Install dependencies:
```bash
npm install
```
3. Run the local server:
```bash
npm run dev
```
4. Access the API at:
```
http://localhost:3000/api/quotes
```
## License
This project is open source and available under the [MIT License](LICENSE).
## Socials
- Facebook: [Charmingdc](https://www.facebook.com/profile.php?id=61554495275289)
- X: [Charmingdc 🎯](https://x.com/Charmingdc01?t=Ui8naP3g7jA6NoejvGyoGQ&s=09)
- TikTok: [Charmingdc](https://www.tiktok.com/@charmingdc01?_t=8rOvHIYhIJE&_r=1)