Skip to content
This repository was archived by the owner on Feb 1, 2023. It is now read-only.

Latest commit

 

History

History
56 lines (43 loc) · 2.36 KB

File metadata and controls

56 lines (43 loc) · 2.36 KB

Organizing book clubs has never been this easy.
Find readers with similar book tastes to co-read books with. Propose and vote for which book to read next and let YomuBo calculate the book with most votes!

Planned Features

  • Landing page
  • User registration and login
  • Book club creation and administration
  • Search and join book clubs
  • Add books to read in the book club
  • Vote for books to read in the book club
  • View relevant information about the book
  • Coordinate meeting (digital or physical)

Folder Structure

A brief description of the file structure can be found in the table below:

Folder Description
/public Contains general assets
/src Scripts and associated assets, divided into categories
/src/Components Component views and presenters paired in folders
/src/Config Configuration files (placeholder files need to be filled in)
/src/Images Image files used by other elements of app
/src/Pages Pages of the application
/src/Store Application state and persistence associated scripts
/src/Utils Utilities used by other elements of app

For more detailed information on the function of individual files, please read the documentation within these.

Commands

The following commands can be run to perform tasks within the project:

Command Description
npm install Install tools for running app
npm run start Starts app in development mode
npm run build Builds the app for production

Git Rules

Don't commit directly to master
Don't merge your own commits

Developers

Daniel - Product Owner, Backend specialist
Azmeer - Backend Specialist, Architecture specialist
William - Git Master, Frontend specialist
Johannes - Scrum Master, Frontend specialist

Frameworks

React - Redux
Frontend/UI -Bootstrap 5