Med - My English Dictionary

Med is a web application designed to help users learn English more effectively. It allows users to create personalized dictionaries, group words by categories, and even connect with friends who are also learning English.

---

Features

• Create Your Dictionary: Add and manage your own English words with meanings and examples.
• Group Words: Organize words into categories or topics for better learning.
• Find Friends: Connect with other users, share progress, and motivate each other.
• Interactive Learning: Engage with tools and activities to enhance vocabulary retention.

---

Repository

The source code for the project is hosted on GitHub. Clone the repository to start:
Med - My English Dictionary

---

Setup and Installation

1. Clone the Repository

Clone the repository to your local machine and save it under a specific name (e.g., med):

git clone https://github.com/HappyMaxxx/Med-My-English-Dictionary med
cd med

2. Create a Virtual Environment

Create and activate a Python virtual environment:

python3 -m venv venv
source venv/bin/activate  # For Linux and macOS
# or
venv\Scripts\activate     # For Windows

3. Install Dependencies

Install the required dependencies from requirements.txt:

pip install -r requirements.txt

4. Set Up Docker and Redis

This project uses Redis for caching or managing task queues.

Install Docker

Download and install Docker from the official website: Docker.

Run Redis with Docker and Celery

Start the Redis container using Docker:

docker run -d --name redis-server -p 6379:6379 redis

Start the Celery worker:

celery -A mad worker -l info

In another terminal:

celery -A mad beat -l info

To control the celery taps and worker, you can run flower in another terminal:

celery -A mad flower

Setting up .env

Rename the example.env file to .env and change the mail data in it. First you must generate specific password for your app in gmail settings.

5. Run the Project

Start the Django development server:

python manage.py runserver

Additional Commands

Check if Redis is Running

Ensure that the Redis container is up and running:

docker ps

Stop Redis

Stop and remove the Redis container if necessary:

docker stop redis-server
docker rm redis-server

Deactivate Virtual Environment

When finished, deactivate the virtual environment:

deactivate

Requirements

• Python 3.8+
• Docker
• Redis
• Django (check dependencies in requirements.txt)

For more details or questions, feel free to contact the developer.