{"id":26482414,"url":"https://github.com/borisplaton/typing_speed_trainer","last_synced_at":"2026-04-02T02:50:45.974Z","repository":{"id":37636415,"uuid":"505273784","full_name":"BorisPlaton/typing_speed_trainer","owner":"BorisPlaton","description":"The typing speed trainer via Django \u0026 JS","archived":false,"fork":false,"pushed_at":"2022-12-21T09:06:28.000Z","size":312,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2023-03-05T12:38:29.681Z","etag":null,"topics":["django","docker","javascript","nginx"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BorisPlaton.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-20T02:47:41.000Z","updated_at":"2022-11-09T08:47:26.000Z","dependencies_parsed_at":"2023-01-30T03:15:37.486Z","dependency_job_id":null,"html_url":"https://github.com/BorisPlaton/typing_speed_trainer","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BorisPlaton%2Ftyping_speed_trainer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BorisPlaton%2Ftyping_speed_trainer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BorisPlaton%2Ftyping_speed_trainer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BorisPlaton%2Ftyping_speed_trainer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BorisPlaton","download_url":"https://codeload.github.com/BorisPlaton/typing_speed_trainer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244547614,"owners_count":20470104,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","docker","javascript","nginx"],"created_at":"2025-03-20T04:13:41.797Z","updated_at":"2025-12-30T20:58:12.494Z","avatar_url":"https://github.com/BorisPlaton.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Typing speed trainer\n\nIt is a typing speed trainer web application implemented via [Django](https://www.djangoproject.com/) and vanilla JavaScript.\n\n![Main page](https://i.postimg.cc/XqMwcMTh/Screenshot-from-2022-11-09-09-19-22.png \"Main page\")\n\n![User page](https://i.postimg.cc/gJ3wpxTS/Screenshot-from-2022-11-09-09-19-12.png \"User page\")\n\n## Setup\n\n### Development\n\n### .env.dist\n\nAll environment variables that are used in development are specified in the `.env.dist` file in the `env` folder. Also, this file is used in the `docker-compose.dev.yml` file and shell scripts. \n\n#### Virtual environment\n\nFirstly, you must install all necessary dependencies. For this, you should create a virtual environment. For instance, you may use a `virtualenv`:\n```\n$ virtualenv --python 3.10 venv\n```\nAfterwards, activate it:\n```\n$ . venv/bin/activate\n```\nThe `requirements` directory has two files:\n* `dev.txt` - contains all dependencies that are used during a development process\n* `prod.txt` - contains all dependencies that are used at the production\n\nInstall all packages that are specified in the `dev.txt` file. Run the following command to make it:\n```\n$ pip install -r requirements/dev.txt\n```\n\n#### Application server\n\nThe application uses `Redis` and `Postgres` databases. Also, JavaScript at the frontend uses API for generating random words. To simplify the setup process of all these services you already have a `docker-compose.dev.yml` file that has done it for you. You can start them with all necessary environment variables via shell script `start_environment.sh` that is placed in the `scripts` folder. Type the following command to make it:\n```\n$ . scripts/start_environment.sh\nCreating network \"typing_speed_trainer_default\" with the default driver\nCreating typing_speed_trainer_dev_random_words_api_1 ... done\nCreating typing_speed_trainer_dev_database_1         ... done\nCreating typing_speed_trainer_dev_redis_1            ... done\nSuccess\n```\nAfterwards, make migrations and run the application server:\n```\n$ cd typing_speed_trainer\n$ python manage.py migrate\n$ python manage.py runserver\n```\nTo stop all of them you may run a shell script `down_environment.sh` that is in the `scripts` folder too.\n```\n$ . scripts/down_environment.sh\nStopping typing_speed_trainer_dev_database_1         ... done\nStopping typing_speed_trainer_dev_redis_1            ... done\nStopping typing_speed_trainer_dev_random_words_api_1 ... done\nRemoving typing_speed_trainer_dev_database_1         ... done\nRemoving typing_speed_trainer_dev_redis_1            ... done\nRemoving typing_speed_trainer_dev_random_words_api_1 ... done\nRemoving network typing_speed_trainer_default\nSuccess\n```\n\n#### Tests\n\nThe application uses the [Pytest](https://docs.pytest.org/en/7.2.x/) package for testing. You can run all tests via the following command if you are in the `typing_speed_trainer` directory:\n```\n$ pytest\n```\n\n### Production\n\n#### .env\n\nBefore starting the application, you must create `.env` in the `env` folder. You already have a `.env.prod` file, which contains the template of the `.env` file and several default values. You may use it in the development.\n\n#### Start application\n\nYou have a `docker-compose.yml` file in the root directory with all necessarily configuration. If you have created the `.env` file, you will start the application if you print following command:\n```\n$ docker-compose up\n```\nThe application works on `8000` port at the `127.0.0.1` ip address. Now you can go to browser and check it out.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fborisplaton%2Ftyping_speed_trainer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fborisplaton%2Ftyping_speed_trainer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fborisplaton%2Ftyping_speed_trainer/lists"}