README.md

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

   git clone https://github.com/NickNaskida/CodeTyper.git

2. Navigate to the project directory

   cd CodeTyper

3. Create & activate a virtual environment

   python -m venv venv
   source venv/bin/activate

4. Install the required packages

   pip install -r requirements.txt

5. Run the migrations

   sudo bash scripts/linux/migrate.sh

6. Run the application

   export FLASK_APP="main"
   flask run

📋 Project Stack

• Python
• Flask
• SQLAlchemy
• SQLite
• JavaScript
• ...

👨🏼‍🔬 Contributors:

• Nikoloz Naskidashvili @NickNaskida
• Bakuri Sheylashvili @Bqko
• Tornike Kadeishvili @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)
• 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 file for details