Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.67 KB

README.md

File metadata and controls

25 lines (18 loc) · 1.67 KB

BonFire

A Student Kanban Board for seeing all your class work in one place! Designed by Hello World 418! Check out 418 - I'm a teapot!

Motivation

Welcome to BonFire, a kanban-board web app designed and created by students with one purpose: providing students and teachers with a simple feature-rich interface to keep track of their classes and class-work.

Throughout Covid-19, it has become more apparent how difficult it is to keep track of assignments for online and in person classes. We hope to implement features on top of kanban functionality to solve this issue.

Installation

In order to install the web app, take a look at the separate readme in both frontend and backend. Database information can be found in the backend as well since we are using a database ORM.

Contributions

We welcome and encourage any incoming contributions from the open source community. In order to contribute to the project, please follow the following guidelines:

  • Create a pull request with the following format:
    • <commit-type>(scope): [WRLD-#] description
      • commit types can be found here
      • scope is optional, some examples: backend, frontend
      • [WRLD-#] refers to ticket for the jira board
      • description should be present tense
  • Ensure there is at least 1 review before merging a pull request
  • Ensure your changes can be built without any errors