Skip to content

nashvillefcc/light-bright-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Light Bright Web App

This application is a simple recreation of the classic Lite-Brite toy which can be played in the browser. We will be using HTML, CSS, and JS for development, without any framework dependencies.

Goals

Currently, we are primarily in the design phase of development for this application. Open design and development issues can be found on the project board of our repo.

MVP design document can be found here: TODO (include link to design doc)

Our current design mockup can be found here: https://www.figma.com/file/QQ1lUDGRm0nNJqZdisO519/Light-Bright?node-id=0%3A1

Installation

Clone or fork the repo to your local machine, and use your editor of choice for development. We recommend VS Code for beginners. We are only using HTML, CSS, and JS for development, without any framework dependencies.

Currently the application is not being hosted online, so you will need a local server for development and testing. The Live Server extension in VS Code may be helpful.

Contributing

Current and past issues are being tracked on the project board of our repo. If you would like to propose a new issue or feature, please add it to the Backlog column and notify the team.

Development to the master branch is locked. Code changes should be introduced through feature branches and reviewed through a pull request. A short primer on pull requests can be found here: https://guides.github.com/introduction/flow/. We require at least 1 approval from other developers per pull request. Please make sure to update tests as appropriate.

You can use the following template for your PR description:

Resolves #[Replace with issue number]
# Description of Changes
[Replace with description of what you changed or introduced. Developers should be able to read this and the Files Changed section and have a good understanding of what this PR is about.]

## How Can I Test This?
[Replace with instructions for another developer to quickly test our your new code. If they need to copy/paste code from here to get it working, provide the code below in brackets.]

Once the pull request is generated and ready for review, please notify the team on Discord.

License

MIT

This application is being developed for nonprofit educational purposes and without referencing any design materials from the original creator.