https://github.com/rbrickmn/syntaxsprint-app
Practice common JavaScript code blocks with SyntaxSprint, the typing test for programmers!
https://github.com/rbrickmn/syntaxsprint-app
css front-end-development html javascript react react-game typing-game
Last synced: 11 months ago
JSON representation
Practice common JavaScript code blocks with SyntaxSprint, the typing test for programmers!
- Host: GitHub
- URL: https://github.com/rbrickmn/syntaxsprint-app
- Owner: rbrickmn
- Created: 2024-08-16T14:46:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-17T15:34:24.000Z (about 1 year ago)
- Last Synced: 2025-03-26T06:11:16.930Z (12 months ago)
- Topics: css, front-end-development, html, javascript, react, react-game, typing-game
- Language: JavaScript
- Homepage: https://syntaxsprint-app.vercel.app/
- Size: 94.7 KB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SyntaxSprint
> This project is just beginning! I have lots of new features planned - see "Roadmap" to find out what I'm working on!
## About This Project
Welcome to SyntaxSprint! A syntax-based typing game that allows you to practice common code blocks, see your typing speed (WPM), and improve your knowledge by trying to lower your mistakes made!
### Built With
* [npm](https://www.npmjs.com/)
* [React.js](https://react.dev/)
* [Vite](https://vite.dev/)
### Features
* JavaScript language syntax (more languages coming sooon!)
* Words per minute (WPM) counter
* Mistakes counter
* Wins/losses counter
* Settings menu
* Option to reset your scores
## Getting Started
This application is fairily simple to get running on your machine. Here is all you need to know!
### Prerequisites
* npm
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/github_username/repo_name.git
```
2. Install NPM packages
```sh
npm install
```
3. Run using Vite
```sh
npm run dev
```
## Contribution
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Roadmap
- [x] Create a syntax-based typing game
- [x] Allow users to customize their settings (Partially implemented)
- [x] Allow users to save their progress
- [ ] Allow users to choose their preferred language
- [ ] Allow users to choose their preferred colors and theme (In development!)