-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update README and minor improvements
- Loading branch information
Showing
5 changed files
with
139 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| name: Python CI | ||
|
|
||
| on: | ||
| - push | ||
| - pull_request | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| matrix: | ||
| # we want to test our package on several versions of Python | ||
| python-version: [3.8, 3.9] | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: Set up Python ${{ matrix.python-version }} | ||
| uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
| # make depends on poetry | ||
| - name: Install dependencies | ||
| run: | | ||
| pip install poetry | ||
| make install | ||
| - name: Run linter and check dependencies | ||
| run: | | ||
| make check-ci |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,43 @@ | ||
| # english-exercises-app | ||
| # english-exercises-app | ||
|
|
||
| [](https://english-exercises-app-production.up.railway.app/) | ||
| [](https://github.com/tmvfb/english-exercises-app/actions) | ||
|
|
||
| ## Description | ||
| Python package to generate English practice exercises from an uploaded text. Web backend (module **english_exercises_app**) is written in Django. Module **text_processing** is responsible for data processing and exercise generation using *gensim* and *spacy* libraries. Web app includes authentication system to remember user and exercise generation parameters, as well as to store user stats. | ||
|
|
||
| **Key features:** | ||
| * User registration and authentication, user answer stats | ||
| * 4 types of exercises (type text, select correct answer, complete sentence, drag and drop) | ||
| * Light/dark mode implementation with Bootstrap 5.3.0 | ||
| * 2 languages support (English, Russian) | ||
|
|
||
| ## Prerequisites (for local deploy) | ||
| * Python >=3.8.1 | ||
| * pip >=22.0 | ||
| * poetry >=1.4.0 | ||
| * GNU make | ||
| * Configured PostgreSQL database | ||
|
|
||
|
|
||
| ## Local installation (WSL/Linux) | ||
| ``` | ||
| $ git clone https://github.com/tmvfb/english-exercises-app.git | ||
| $ cd english-exercises-app.git | ||
| $ make install | ||
| ``` | ||
| Then configure environment variables below. | ||
| Apply migrations via `python3 manage.py migrate`. | ||
| Run `make dev` to start dev server. | ||
|
|
||
| ## Environment variables | ||
| ``` | ||
| SECRET_KEY= | ||
| DATABASE_URL= | ||
| ``` | ||
|
|
||
| ## Todo list | ||
| * Full CRUD for users | ||
| * New exercise types and adding more variability to old ones | ||
| * Better design for drag and drop exercises | ||
| * Write some tests? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters