https://github.com/nicknaskida/codetyper
Simple, minimalistic code typing game, where you can practice your code typing skills and improve productivity, accuracy and speed.
https://github.com/nicknaskida/codetyper
flask javascipt python typing typing-test typingspeedtest
Last synced: 5 months ago
JSON representation
Simple, minimalistic code typing game, where you can practice your code typing skills and improve productivity, accuracy and speed.
- Host: GitHub
- URL: https://github.com/nicknaskida/codetyper
- Owner: NickNaskida
- License: wtfpl
- Created: 2023-10-18T05:02:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T19:46:03.000Z (over 1 year ago)
- Last Synced: 2024-09-15T04:56:54.349Z (over 1 year ago)
- Topics: flask, javascipt, python, typing, typing-test, typingspeedtest
- Language: HTML
- Homepage:
- Size: 50.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Code Typer
### Project Description
Code Typer is a simple, minimalistic code typing game, where you can practice your code typing skills and improve productivity, accuracy and speed.
### 🎥 Project Demo
### 📋 Documentation
1. Clone the repository
```sh
git clone https://github.com/NickNaskida/CodeTyper.git
```
2. Navigate to the project directory
```sh
cd CodeTyper
```
3. Create & activate a virtual environment
```sh
python -m venv venv
source venv/bin/activate
```
4. Install the required packages
```sh
pip install -r requirements.txt
```
5. Run the migrations
```sh
sudo bash scripts/linux/migrate.sh
```
6. Run the application
```sh
export FLASK_APP="main"
flask run
```
### 📋 Project Stack
- Python
- Flask
- SQLAlchemy
- SQLite
- JavaScript
- ...
### 👨🏼🔬 Contributors:
- Nikoloz Naskidashvili [@NickNaskida](https://github.com/NickNaskida)
- Bakuri Sheylashvili [@Bqko](https://github.com/Bqko)
- Tornike Kadeishvili [@Tornike-I](https://github.com/Tornike-I)
### 👨🏼🔬 Contributing
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 in advance!
In general, we follow the "fork-and-pull" Git workflow
#### How to submit a Pull Request
- Search our repository for open or closed Pull Requests that relate to your submission. You don't want to duplicate
effort.
- Fork the project on GitHub.
- Create your feature branch
- Do your work. Read the docs to this project.
- Commit your changes (Please use semantic commit
messages: [Semantic commit messages](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716))
- Push to the branch
- Open a Pull Request and wait for feedback.
🎉 Thank you for your contribution!
### 📋 License
This project is licensed under the WTFPL License - see the [LICENSE](LICENSE) file for details