ychab / miolingo

A language-learning app to suit your needs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

lint units poetry django version

MioLingo Backend

Miolingo is a project to learn languages, but YOU are our own teacher!

This backend is build with Django and Django Rest Framework.

Requirements

  • For development, into a virtualenv (recommended) :

    • you must first install poetry.
    • Once installed, just run: poetry install
  • For testing (CI), just do : pip install -r requirements/test.txt

  • For production, do instead : pip install -r requirements/prod.txt

Note: For now, only Python 3.10 is tested.

Databases

Having access with proper permissions for one of the supported SGDB by Django.

Pre-commit

Python binding package should be already installed by Poetry, so you just have to do:

pre-commit install

That's it!

ugly tips: If you want to skip check for a particular commit, do:

git commit -m "blabla" --no-verify

but hope this is for good reasons huh!!

Get started

Local installation

Once requirements are setup, do the following steps:

cp miolingo/settings/local.py.dist miolingo/settings/local.py
vim miolingo/settings/local.py  # edit at least DATABASES and SECRET_KEY !
python manage.py migrate
python manage.py createadmin --password=<PASSWORD>
./manage.py runserver 127.0.0.1:8000
google-chrome http://127.0.0.1:8000/admin &

Tips: take a look at the Makefile ;-)

About

A language-learning app to suit your needs

License:MIT License


Languages

Language:Python 98.6%Language:Makefile 1.4%