Master Of Keys

Welcome to our Typing Website! This platform is designed to help users improve their typing speed and accuracy through engaging and interactive exercises.

Features

• Typing Practice: Improve your typing skills with real-time feedback.
• Progress Tracking: Monitor your typing speed and accuracy over time.
• User Authentication: Secure login and registration system.
• Responsive Design: Seamless experience across devices.

Tech Stack

• Backend: Django
• Frontend: React
• Database: SQLite (development) / PostgreSQL (production)
• API: RESTful API using Django REST Framework

Installation

Backend Setup

1. Clone the repository:

git clone https://github.com/RudraNarayan94/MOK.git
cd MOK

2. Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies:

pip install -r requirements.txt

4. Run migrations:

python manage.py migrate

5. Start the development server:

python manage.py runserver

Frontend Setup

1. Navigate to the frontend directory:

cd ../frontend

2. Install dependencies:

npm install

3. Start the development server:

npm start

Usage

1. Open your browser and navigate to http://localhost:3000 for the frontend.
2. The backend API runs at http://localhost:8000.

Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Commit your changes and push the branch.
4. Submit a pull request.

License

This project is licensed under the MIT License.

Contact

For any questions or feedback, please contact us at [email protected].

Running the Background Tasks

1. Start Redis Server:

# Windows (WSL or Redis Windows)
redis-server

# Linux/Mac
sudo service redis-server start

2. Start Celery Worker:

# From Backend/project directory
celery -A core worker -l info

3. Start Django Server:

python manage.py runserver