https://github.com/meekb/un_bored

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/meekb/un_bored
Owner: Meekb
Created: 2021-08-04T15:25:49.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2021-08-11T23:20:27.000Z (almost 5 years ago)
Last Synced: 2025-03-06T17:50:06.373Z (over 1 year ago)
Language: JavaScript
Size: 3.02 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# GET Un-Bored
## Activity Generator for Indecisive Humans
### Front-End Project by: [Beth Meeker](https://github.com/Meekb)

## Overview
Have you ever been so bored that you don't know what to do? GET Un-Bored is an activity generator designed for indecisive humans. Using data from [Bored API](https://www.boredapi.com/documentation#endpoints-accessibility), users recieve a randomly generated activity card each time they click the DO A THING button. A drop down menu allows the choice of nine categories from which to get an activity, or simply leave category unselected to receive a suggestion from a random category. Users can save the activity suggestions they like. The Saved view will allow users to Complete or Delete a saved activity. Once an activity is completed, the card is moved to the user Showcase along with a timestamp of completion. If you're feeling bored, Do A Thing and GET Un-Bored!

## Instructions
* Clone down this repository git clone (git@github.com:Meekb/Un_Bored.git)
* CD into your local clone cd un-bored
* Install project dependencies npm install
* Run npm start
* Open (http://localhost:3000/) in your preferred browser

## Construction
* Built with React
* Uses strictly Functional Components with React Hooks
* Uses State to save/delete user activities
* React Router gives users an authentic navigation experience
* Fetches data from Bored API
* Minimal styling with plaster wall backdrop for a truly boring display
* Completed activities are displayed with colorful animated border
* Categories: Education, Recreation, Social, DIY, Charity, Cooking, Relaxation, Music, Busywork
* Error component for faulty url

From Un-Bored Home, users can generate a random activity by clicking the 'Do A Thing' button:
![unbored Home](https://user-images.githubusercontent.com/76264735/128799600-b220a7ee-1aa1-4eea-9f3d-210fbd25b7cf.gif)

Suggested activities can be saved:
![unbored Save](https://user-images.githubusercontent.com/76264735/128798832-7dff06cf-3a07-4cfe-bdbc-af05b6caefb9.gif)

In Saved view, users can delete saved activities:
![unbored Delete](https://user-images.githubusercontent.com/76264735/128799132-4b2849f4-d5fd-412d-8b2a-9f4da0b99bca.gif)

Users can Complete activities which will be timestamped and moved into the Showcase:
![completeunbored](https://user-images.githubusercontent.com/76264735/128799851-7cfd4b51-a29f-4f0b-ba3c-86fdaec3213c.gif)

## Future Improvements
* Each completed activity will be clickable, allowing user to add images and comments
* Activity cards will include links to information about the activity

## Tech Stack

JavaScript ES6
CSS
React
React Router
Cypress