🎓 Your Perfect Tutor - English Teacher project

Table of contents

• Description
• Technologies
• Setup
• Improvement plans

📃 Description:

A website for an English tutor that has the function of a business card and also:

• User registration
• Handing out homework to students
• Tracking learning progress
• Creating of a personal dictionary with the translation of words, automatic addition of phonetic transcription, the ability to download a dictionary in the excel format, etc.
• Take tests with words from your dictionary in different modes.

The website is deployed and used for its intended purpose.

🛠️ Techs:

• Python 3.10
• Django 3.2
• PostgreSQL
• Testing with Django unit tests
• HTML, CSS, Bootstrap 5
• Docker, docker-compose, nginx and gunicorn
• CI/CD using GitHub Actions

💻 How to run the project on your computer:

Clone the repository:

git clone https://github.com/Rezenhorn/english_teacher.git

Create file .env in directory infra/ and fill it in according to the example (file .env.example).

Make sure, that Docker is installed on your system and launched. From directory infra/ start Docker:

docker-compose up -d --build

Apply migrations, create superuser, collect static:

docker-compose exec web python manage.py migrate

docker-compose exec web python manage.py createsuperuser

docker-compose exec web python manage.py collectstatic --no-input

You will find the running website at URL http://localhost/.

If you want to stop running containers:

docker-compose down -v

📈 Improvement plans

• New frontend
• Refactor CSS structure
• Add more quiz modes
• Separate page for each word in the dictionary with extended info

👨‍💻 Author:

• Dmitry Fomichev