Joxx - Joke Generator Web App
Joxx is a simple web application built with Express.js that allows users to generate random jokes and dad jokes. The application leverages the Joke SDK to fetch jokes from external APIs and presents them in a user-friendly interface.
Features
- Random Jokes: Click the "Generate One More" button to get a random joke.
- Dad Jokes: Click the "Generate One More Dad Joke" button for a dad joke experience.
- Navigation: Easily navigate between the joke categories and go back to the main page.
Installation
Clone the repository:
git clone https://github.com/your-username/joxx.git
Install dependencies:
cd joxx
npm install
Run the application:
npm start
The app will be accessible at http://localhost:5000
in your web browser.
Dependencies
- Express.js: Web application framework for Node.js.
- Joke SDK: SDK for fetching random jokes and dad jokes.
Usage
- Access the main page at
http://localhost:5000
.
- Click on the "Generate One More" button to get a random joke.
- For dad jokes, click on the "Generate One More Dad Joke" button.
- Use the "Go Back" button to return to the main page.
Contributing
If you'd like to contribute to Joxx, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
.
- Make your changes and commit them:
git commit -m 'Add new feature'
.
- Push your changes to your fork:
git push origin feature/your-feature-name
.
- Open a pull request to the
main
branch of the original repository.
License
This project is licensed under the MIT License.
Acknowledgments
- Joke SDK for providing the jokes API.
- Tailwind CSS for styling the web interface.
Feel free to enhance and customize Joxx according to your preferences!