/quotd

📜✨ A public API serving inspiring and uplifting quotes and aphorisms to elevate the human spirit!

Primary LanguageTypeScriptMIT LicenseMIT

The Quotd API 📜✨

Build Status Test Coverage License: MIT GitHub stars GitHub forks

Welcome to Quotd, a beautifully crafted public API serving inspiring and uplifting quotes and aphorisms to elevate the human spirit! 🚀

🌟 Features

  • Get random quotes
  • Access quotes by ID
  • Explore all quotes
  • Discover categories
  • Browse authors
  • View all quotes from a specific author

📚 Table of Contents

⚡ Quick Start

Get a random quote with a simple `curl` command:

curl https://api.quotd.io/quotes/random

Or retrieve a specific quote:

curl https://api.quotd.io/quotes/1

🛠️ Usage Examples

JavaScript

fetch('https://api.quotd.io/quotes/random')
  .then((response) => response.json())
  .then((data) => console.log(data));

Python

import requests

response = requests.get('https://api.quotd.io/quotes/random')
data = response.json()
print(data)

Ruby

require 'httparty'

response = HTTParty.get('https://api.quotd.io/quotes/random')
data = response.parsed_response
puts data

📖 API Documentation

For more detailed information on the API endpoints and capabilities, check out the official documentation.

💻 Development

📦 Installation

npm install

⚙️ Configuration

# Copy sample .env file. You may need to edit the values.
cp .env.dist .env

🗄️ Set up the database

# Start the supporting services in background
npm run db:up

# Setup the database
npx prisma db push

# Seed the database (optional)
npx prisma db seed

🚀 Running the app

# development
npm run start

# watch mode
npm run start:dev

# production mode
npm run start:prod

🧪 Testing

# unit tests
npm run test

# e2e tests
npm run test:e2e

# test coverage
npm run test:cov

📄 License

Quotd is MIT licensed.