Boredom is a simple web application designed to alleviate boredom by providing users with interesting and diverse activities to engage in. The application utilizes Node.js along with Express.js for the backend, EJS for dynamic HTML rendering, and integrates with the Bored API to fetch a variety of activities based on user preferences.
The following technologies and tools were used to develop this project:
- HTML
- CSS
- JavaScript
- Node.js
- Express.js
- EJS (Embedded JavaScript)
- Bored API
Follow these steps to get the project up and running on your local machine for development and testing:
To run Boredom locally, follow these steps:
-
Clone the repository:
git clone https://github.com/username/boredom.git
-
Install the required dependencies using npm:
npm install
-
Start the website:
node index.js
-
Open your web browser and navigate to
http://localhost:3000to access the website.
- On the homepage, you will find two dropdowns, one for the type of activity and the other for the number of participants.
- Select the desired type (education, charity, recreational, relaxation, busywork, social, diy, music) and the number of participants (1 to 4).
- Click the "Go" button to fetch a random activity that matches your criteria.
- The application will display the selected activity with relevant details.
Contributions to Boredom are welcome! To contribute, follow these steps:
-
Fork the repository.
-
Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
-
Make changes and commit them:
git commit -m "Add your commit message here" -
Push your changes to your branch:
git push origin feature/your-feature-name
-
Create a pull request on the main repository. Please follow the project's coding guidelines and maintain a clean commit history.
If you have any questions or feedback, feel free to reach out to us at therahman14@gmail.com. We're excited to hear from you and make this project even better!