Skip to content

jojoferret/graveyard-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸͺ¦ GraveyardAPI

β€œEvery project graveyard deserves a monument.”

GraveyardAPI is a RESTful API for the forgotten.
A place to bury your abandoned side projects, startup ideas, and half-baked dreams.
Pay your respects. Read the ruins. Move on.


⚰️ What is this?

GraveyardAPI lets users:

  • Submit dead project ideas (POST /api/dreams/)
  • Browse a public graveyard of failed ambition (GET /api/dreams/)
  • Pay respects with a single RIP (POST /api/dreams/{id}/rip/)
  • Pull random dreams from the void (GET /api/dreams/random/)
  • See stats on our collective failure (GET /api/stats/)

πŸ’‘ Why?

Because not every idea gets finished.
Because not every project needs to be forgotten.
Because you deserve to laugh (or cry) at what you never shipped.


πŸ› οΈ API Endpoints

Method Endpoint Description
GET /api/me/ View your profile info
POST /api/dreams/ Submit a new dead dream
GET /api/dreams/ List all dreams (paginated)
GET /api/dreams/{id}/ View a single dream
DELETE /api/dreams/{id}/ Delete your own dream
POST /api/dreams/{id}/rip/ Pay your respects (1 RIP only)
GET /api/dreams/random/ Return one random dead dream
GET /api/stats/ View global RIP and tag stats

πŸ” Authentication

  • Token-based auth via Authorization: Token <your_token>
  • Anonymous users can still view + submit (with limits)

🚦 Rate Limits (Throttle)

Action Authenticated Anonymous
Submit Dream 20/hour 5/hour
RIP a Dream 10/hour ❌
View Dreams 200/hour 60/hour
Random Dream 100/hour 30/hour
View Stats 15/hour 15/hour

🎨 Tags

  • Add up to 5 tags to each dream
  • Tags are global (e.g. frontend, ai, no-motivation)
  • Browse dreams by tag using GET /api/dreams/?tag=ai

πŸ“˜ Swagger Docs

β†’ API Docs here
(Optional: Available only in dev / protected in prod)


πŸͺ¦ Example JSON Payload

POST /api/dreams/
{
  "title": "An AI that generates startup ideas",
  "reason_abandoned": "It kept giving me ideas I'd already failed to build",
  "tags": ["ai", "startup", "loop"]
}

About

RIP to the apps that never shipped.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages