ReadTrack: Your Personal Bookshelf in the Cloud

The Live Site

Submit a link to your front-end code live on the web, and include that link on your README.md document.

The deployed ReadTrack app

Product Vision Statement

To empower book enthusiasts by creating a dynamic and engaging online platform that revolutionizes the way users discover, organize, and share their reading experiences. Our vision is to launch a user-friendly web app that offers instant access to a comprehensive book database, enables personalized book management through 'Currently Reading', 'Want to Read', and 'Finished Reading' lists, and fosters a community of readers who can explore and connect over shared literary interests. By releasing an MVP that encapsulates the core functionalities of profile customization, book list management, and user interaction, we aim to quickly gather feedback for iterative enhancements, ensuring our solution not only meets but exceeds the evolving needs of our audience.

• Personalization: Establishing The Vision
• User Engagement: Profile creation/ editing
• User Engagement: Viewing other users' profiles
• Content Discovery: Searchable and browseable database of books
• Content Discovery: Recommendations based on user activity
• Personalization: Creating and managing book lists such as "Currently Reading," "Want to Read," and "Finished Reading"
• Personalization: Personalized book suggestions

Core Members

• Kiara Chombo
• Connor DeLeon
• Hannah Horiuchi
• Ellis Pinsky
• Jeffery Saeteros

Instructions

To run ReadTrack, we recommend you begin by forking this repository, then cloning that to your local machine. Alternatively, you may clone this repository to your local machine.

Then navigate to the root of the project directory and run the following commands to install dependencies and begin running the project:

npm install

npm start

Testing

To test this project, run the following commands:

cd back-end

npm test

Product Development

A short history of how our project came to be:

1. See the App Map & Wireframes and Prototyping instructions for the requirements of the initial user experience design of the app.

   During Sprint 0, the team convened virtually to discuss the different pages we believe our application would need. We created a list of these pages then distributed the pages for each team member to work on the wireframes for. Afterwards we connected all of the pages so that buttons on one page may link to another page so that the wireframe would be ready to present to shareholders.

2. See the Sprint Planning instructions for the requirements of Sprint Planning for each Sprint.

   During the second part of Sprint 0, the team convened (both virtually and in-person) on multiple occasions to establish, discuss, and check-in on the different parts of the front-end that needed to be created. The team began by taking the previously created user stories and transforming them into tasks. These tasks were then distributed across Github's project board into columns labeled "Todo," "In Progress," and "Complete." After creating the tasks, team members each selected 3-5 tasks to focus on throughout the sprint.

3. See the Front-End Development instructions for the requirements of the initial Front-End Development.

   During Sprint 1, the team convened virtually and in-person to discuss and review work done on the front end. The front end was initially developed to closely resemble the wireframe but was later configured to have a more user-friendly aesthetic.

4. See the Back-End Development instructions for the requirements of the initial Back-End Development.

   During Sprint 2, the team convened virtually, mostly via discord, to discuss which pages of the website each team member should focus on to change from static to dynamic.

5. See the Database Integration instructions for the requirements of integrating a database into the back-end.

   During Sprint 3, the team convened virtually, primarily via discord, and in person to discuss the ways in which the team would integrate the MongoDB database into the back-end code created during the previous sprint. During this process, the team members also discussed adjustments to the structure of the database and back-end that would improve the project's workflow.

6. See the Deployment instructions for the requirements of deploying an app.

   During Sprint 4, the team convened virtually, mostly using discord, to discuss the final touches to the project prior to deployment.

Contributing

If you are interested in contributing to our project, please check out our Guide to Contributing for information on how to do so.

Development Details

• The project's wireframe is developed using Figma.
• The project's front-end is developed using ReactJs and TailwindCSS.
• The project's back-end is developed using ExpressJS.