Deez Nuts Jokes API

The Deez Nuts Jokes API allows users to access a collection of jokes about Deez Nuts to use in their applications. 🥜 Also available on RapidAPI.

A wrapper built with TypeScript/JavaScript is also available on npm.

Report Bug · Suggest a joke

📔 Table of Contents

• About the Project
  • Tech Stack
  • Features
  • Environment Variables
• Getting Started
  • Run Locally
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

👾 Tech Stack

• FastAPI
• Supabase
• PyTest
• SlowAPI
• Deta

🎯 Features

• Get an array of all jokes in the database

curl -X 'GET' \
  'https://deezjokes.deta.dev/jokes' \
  -H 'accept: application/json'

• Get a random joke from the database

curl -X 'GET' \
  'https://deezjokes.deta.dev/joke/random' \
  -H 'accept: application/json'

• Get a joke by ID

curl -X 'GET' \
  'https://deezjokes.deta.dev/joke/1' \
  -H 'accept: application/json'

• Get a joke by search query

curl -X 'GET' \
  'https://deezjokes.deta.dev/joke/search?keyword=boba' \
  -H 'accept: application/json'

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

SUPABASE_SUPAFAST_URL and SUPABASE_SUPAFAST_KEY

🧰 Getting Started

🏃 Run Locally

Clone the project

  $ git clone https://github.com/DeviousLab/DNJokes-API.git

Go to the project directory

  $ cd DNJokes-API/api

Install dependencies

  $ pip install -r requirements.txt

Start the server

  $ uvicorn main:app --reload

🧭 Roadmap

• Add handler to suggest new jokes
• Setup issue/PR templates
• Develop NodeJS/Typescript wrapper for API

👋 Contributing

Contributions are always welcome! Open an issue with any issues or requests!

⚠️ License

Distributed under the MIT License. See LICENSE.md for more information.

🤝 Contact

[email protected] deviouslab.dev

💎 Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.

• Shields.io
• Readme Template
• @aUnicornDev