Skip to content
This repository was archived by the owner on Jun 24, 2020. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
31 changes: 31 additions & 0 deletions docs/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added docs/screenshots/app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.