DrSLMac / bookworm

Final Solo Project for Turing School of Software and Design, Mod 3, utilizing React, Router, Cypress, RESTful APIs, XLM, & CSS

Table of Contents 📖

• Introduction
• Learning Goals
• Technologies and Tools
• Illustrations & Demo
• Project Reflections
• Roadmap
• Deployed Page
• Set Up
• Contributors
• Sources
• Project Specs

Introduction

• Welcome to Bookworm, the app that remembers the book for you. Browse through the lists from the New York Times Bestsellers, filter by genre or view them all. Hover over a book to see more details, such as author, publisher, and description. Save books that sound interesting so that your list is ready the next time you are at the library, bookstore or online, you'll never have to wonder which book you wanted to read next.
• This is the final showcase solo project for Module 3 of Turing School of Software and Design.
• The purpose of the project was to create a React act from the ground up, in a week. This application utilizes React Router and performs End-to-End testing using Cypress.

Learning Goals

Use the technology we have been working with over the course of the module to demonstrate mastery of the following:

• React
• Router
• Asynchronous JavaScript
• End to end testing with Cypress

Technologies and Tools

• Javascript
• HTML
• CSS
• npm
• Node.js
• React
• Router
• Cypress Testing
• RESTful API
• GitHub Projects
• GitHub Issues

Illustrations and Demo

Welcome Page

---

Dashboard View

---

Filter Feature

---

Saved Books View

---

Project Reflections

Wins

• Loved designing the CSS animation for the book covers
• Built the welcome page to navigate to dashboard
• Built a project in one week

Challenges

• The E2E testing with Cypress was challenging
• Attempted to implement a carousel for each book genre, but ran out of time to continue with the styling
• The time constraint was challenging overall

Roadmap

Future features could include:

• Option for user to sign in to unique account
• Ability for user to make comments or take notes about a book, maybe even have a writing prompt for each book.
• Option to join book/reading challenges
• Ability to mark a book as 'read'

Deployed Page

Visit the published site here

Set Up

1. Fork this repo
2. Clone the repo to your local machine
3. cd into the root of the project directory
4. Run npm install
5. Run npm start

Contributors

Shauna MacFarlane-Okongo

• LinkedIn
• GitHub

Sources

• MDN
• YouTube
• W3Schools
• React JS
• Router docs
• Cypress docs
• Medium
• CSS Book Animation

Project Specs

• The project spec & rubric can be found here