geek4ctrl / daily-dad-joke

A dad joke a day, to (maybe) make you laugh 😂

The Daily Dad Joke

The Daily Dad Joke is a web application built with Next.js that provides users with a daily dose of dad jokes to brighten their day. This project aims to bring laughter and joy to users by presenting them with a new dad joke every day. Built during #GithubHack23

Features

• Daily Dad Joke: Users can visit the website each day to discover a new dad joke. The jokes are randomly generated by integration with OpenAI and displayed in an appealing and user-friendly manner.

• Archive: The application maintains an archive of previously displayed dad jokes, allowing users to browse through the collection and revisit their favorite jokes whenever they want.

• Sharing: Users can easily share the dad jokes with their friends and family through social media platforms or messaging apps. This feature allows for spreading the laughter and increasing the reach of the project.

TODO:

• Random Joke Generator: In addition to the daily dad joke, users have the option to generate a random dad joke on demand. This feature provides an endless supply of humor for users to enjoy at any time.

Technologies Used

• Next.js: The project is built using Next.js, a React framework for server-side rendering and building static websites. Next.js provides a seamless development experience and optimizes performance.

• React: Next.js utilizes React for building the user interface components, allowing for a modular and reusable codebase.

• Tailwind: The project uses Tailwind for styling the website and ensuring an appealing and intuitive user interface.

• Supabase: The application integrates with Supabase where we save the jokes. Responsible for fetching and serving the jokes to the Next.js application.

Getting Started

To get a local copy of The Daily Dad Joke up and running on your machine, follow these steps:

1. Clone the repository: git clone https://github.com/danicunhac/daily-dad-joke.git.
2. Navigate to the project directory: cd daily-dad-joke.
3. Install the dependencies: yarn install.
4. Start the development server: yarn dev.
5. Open your browser and visit http://localhost:3000 to see the application running.

Contributing

Contributions to The Daily Dad Joke are welcome and encouraged! If you have any ideas, suggestions, or bug reports, please open an issue on the GitHub repository.

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. Create a new branch: git checkout -b my-feature-branch.
4. Make your changes and commit them: git commit -m 'Add new feature'.
5. Push the changes to your forked repository: git push origin my-feature-branch.
6. Open a pull request on the original repository, describing your changes in detail.

Running locally

You'll need to create a local Supabase database and create a jokes table following the docs for Local Development

https://supabase.com/docs/guides/getting-started/local-development

Required environment variables:

• SUPABASE_URL: Link
• SUPABASE_KEY: Link
• OPENAI_API_KEY Link

License

The Daily Dad Joke is licensed under the MIT License. Feel free to use, modify, and distribute the code for personal or commercial purposes.

Acknowledgements

The project acknowledges the following resources and libraries:

• Next.js
• React
• Supabase
• OpenAI API
• Any other dependencies mentioned in the package.json file.

Contact

If you have any questions or inquiries about The Daily Dad Joke, please contact us at [e-mail]. We'd be happy to hear from you!