brni05/quoteosch repository overview

⁠Quoteosch API

An API to spread the eternal wisdom of BME lecturers.

⁠How to use

Explore the API documentation here⁠.

To fetch a random quote: https://quoteosch.sigsegv.hu/quote.

To fetch a random quote from a specific lecturer: https://quoteosch.sigsegv.hu/quote?lecturer=ppeti.

⁠Terms of Use

• Do not suggest offensive or unwanted content.
• Please do not attempt to overload, spam or DDoS the API.
• Do not scrape, copy, or redistribute API data without proper attribution.

⁠How to contribute

Use the dedicated endpoints to suggest a:

• new lecturer⁠
• new quote⁠

Explore all quotes: here⁠.

Explore all lecturers: here⁠.

⁠How to create your own instance

• Clone the repo: git clone https://github.com/BrNi05/Quoteosch.git.

For testing / development:

• Install dependencies: npm install.
• Build the project: npm run build.
• Run the generated migration(s): npm run db:init.
• Create your .env.
• Start the app (in dev mode): npm run start:dev.
• The release folder contains useful resources to host your API.

For production:

• Copy docker-compose.yaml⁠ to a desired location.
• Create your .env.
• For the very first time: docker compose run --rm quoteosch-api-init.
• Then start the API normally: docker compose up -d quoteosch-api.
• The release folder contains a script to auto-start the container on boot.

⁠Tech Stack

• NestJS (Node)
• TypeScript
• TypeORM (with SQLite)
• Swagger (OpenAPI)
• Docker
• Cloudflare Tunnel

⁠Disclaimer

Quoteosch API initially was a joke, but it evolved into a sophisticated project. It's meant for fun and not to offend anyone.