ivnflpz / trainer-cube Goto Github PK

View Code? Open in Web Editor NEW

0.0 1.0 0.0 2.51 MB

HTML 1.26% CSS 0.26% TypeScript 56.19% JavaScript 42.29%

trainer-cube's Introduction

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

`npm start`

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

`npm test`

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

`npm run build`

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

`npm run eject`

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

trainer-cube's People

Contributors

Watchers

trainer-cube's Issues

Config: setup hot-loading for react

Setup react-hot-loader to avoid a full page refresh every time there's a change. Its possible the project will need to be ejected for this to be setup.

Figure out how to handle newlines in Windows/Unix

Figure out how to handle newlines in Windows/Unix to avoid build issues between OSs. This should also re-enable the line-break eslint rule.

Timer: customizable count down

Add a dropdown to the timer view that allows custom countdowns. These should be:

15 seconds
10 seconds
5 seconds
No countdown

Algorithm card: Persist selected primary algorithm

#12 added a radio group component to set the primary algorithm but the changes are lost whenever the page changes/refreshes. These selections should be persisted to

firebase for logged in users
local storage for guests

User state should reset when logging out

Description

The user state changes should not persist when logging out.

Timer: persist times to firebase

Persist times to firebase if the user is logged in. Otherwise, use local storage to avoid losing all times on refresh.

Add scramble steps for all PLL

Description

Add scramble steps for all PLL algorithms.

Algorithm card: add section for all algorithms

Add section to view all solve algorithms. These should be displayed as a list and be separate from each other to allow selecting the primary in a different PR.

Setup tests for at least one component

Description

Add tests for at least one component. These tests should use jest and react-testing-library.
The CircleCI config should be modified to run tests.

Timer: scramble steps

Add a section to the timer view that shows scramble steps. A library like cubejs is probably the best way to do this. A refresh icon should be included to show different scramble steps.

Algorithms: Add all OLL algorithms

Add all OLL algorithm data.

Customizable colors: scheme dropdown

Add a dropdown with commonly used schemes to easily change the cube's colors.

Config: Tweak eslint to be stricter

Current ESlint configuration still leaves a lot of scenarios unformatted. The configuration should be tweaked to support these cases at a minimum:

functions always have return type
max line length
use other plugins with sensible defaults

Avoid initial data flashing when user logged in

Description

When a user is logged, the "Login" button and any user changes on algorithms will flash as the data is retrieved from firebase.

This could potentially be fixed by storing the session and adding a loading delay until the data returns from firebase. On logout, the session should be deleted.