diff --git a/README.md b/README.md index 43d5c78..142aa28 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ # chrono-cube -Frontend part of ChronoCube web application - -a professional timer for speecubing with simple UI, scoreboard, guides and statistics analysis. +This repository is a frontend part of ChronoCube web application - an Open-Source +professional timer for speecubing with simple UI, scoreboard, guides and statistics analysis. +It is already deployed and available at https://eug-vs.github.io/chrono-cube/. + +![screenshot](/docs/screenshots/app.png) + +# Track our progress +Development process is managed through GitHub project. +[Visit out project board!](https://github.com/users/Eug-VS/projects/3) # Technologies stack + We only use modern and most relevant technologies to achieve the best results! - [React.js](https://reactjs.org/) - [Material UI components](https://material-ui.com/) -# Getting started -To run the project, you should have [Node Package Manager](https://www.npmjs.com/) installed. It's also recommended to use -[Node Version Manager](https://github.com/nvm-sh/nvm). - -1. `npm i` (shorthand for `npm install`) - install project dependencies. -2. `npm start` - run the project. + Special thanks to other Open-Source projects which made ChronoCube possible: +- [react-window](https://github.com/bvaughn/react-window) # Contribute -[Contribute to ChronoCube](https://github.com/users/Eug-VS/projects/3) - -Recommended IDE - [WebStorm](https://www.jetbrains.com/webstorm/). It's also preferable to install -`Styled Components & Styled JSX` plugin. +ChronoCube is an Open-Source project and anyone can contribute to it! +Please, take your time to read [out contributing guidelines](/CONTRIBUTING.md). diff --git a/docs/bug_report.md b/docs/bug_report.md new file mode 100644 index 0000000..64399d2 --- /dev/null +++ b/docs/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve +title: BUG +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + +**Additional context** +Add any other context about the problem here. diff --git a/docs/screenshots/app.png b/docs/screenshots/app.png new file mode 100644 index 0000000..b6a285d Binary files /dev/null and b/docs/screenshots/app.png differ