Git Product home page Git Product logo

bookclubwebsite's Introduction

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

bookclubwebsite's People

Contributors

thelizri avatar gyuudon3187 avatar azakh993 avatar johnaren avatar

Stargazers

Nicholas Der avatar Niko avatar

Watchers

Nicholas Der avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.