Assumptions
- I assume that you have added your ssh-keys to your github account:
https://github.com/settings/keys. In case you don't know how to do it, refer to this page:https://help.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh - Node.js v16.17.1 (I prefer NVM as a version manager -- you can install multiple versions using it.). However, this version requirement is subject to change.
- Python v3.6. or above
Installation
- Clone the project using ssh url:
[email protected]:devkurultay/kodjaz_backend.git - Create .env file from the provided template:
cp env_template .env - Go to the project directory:
cd kodjaz_backend - Install JavaScript dependencies (we have some old packages here, that's why we need to include that extra argument):
npm install --legacy-peer-deps - Create a virtual environment called
env:python3 -m venv env - Activate the virtual environment:
source env/bin/activate - Upgrade pip:
pip install --upgrade pip - Install Python dependencies:
pip install -r requirements/requirements_dev.txt - Open two terminal tabs/windows (whatever you prefer)
- In the 1st terminal (in the project directory) activate the virtual environment (in case it's not activated) and install migrations:
./manage.py migrate - Create a superuser:
./manage.py createsuperuser(fill in all the fields) - In the same terminal load the fixtures (dummy data):
./manage.py loaddata fixtures/courses.json - In the same terminal run the Django server:
./manage.py runserver - In the 2nd terminal issue the following command (which will run a watcher.js whose job is to rebuild the project each time it detects some changes under the frontend/src folder):
npm start - Now you can open your favorite editor and start writing your awesome code!
Entities
The product consists of Tracks. Tracks are basically courses. Each track consists of Units. You can think of Units as chapters of a book. Each unit consists of Lessons. Lesson tries to teach a topic. Each lesson consists of Exercises. Every exercise helps a learner to gain knowledge on a topic and practise. Whenever a user submits their code, a new Submission is created. A submission has a link to an exercise. One Exercise can have multiple Submissions.
Endpoints
Swagger page is available here However, I'd recommend using the latest versions of Postman TODO: add screenshots of Postman settings.
TODO: Implement subscription. A track a user is subscribed to will show up in their dashboard.
When we want to display a data of a selected Track, we get data from /api/v1/user/tracks/.
It will give a nested data like this:
[
{
"id": 1,
"name": "Python",
"entity_type": "Track",
"description": "",
"track_units": [
{
"id": 1,
"name": "Python синтаксиси",
"entity_type": "Unit",
"description": "Python синтаксис негиздери",
"unit_lessons": [
{
"id": 1,
"name": "Синтаксис негиздери",
"entity_type": "Lesson",
"is_published": true,
"lesson_exercises": [
{
"id": 1,
"name": "Салам, дүйнө!",
"entity_type": "Exercise",
"previous_exercise": "",
"lecture": "Программалоо бул компьютерди колдонуучу...",
"instruction": "Басып чыгаруу функциясын колдонуп, терминалга...",
"hint": "Текстти басып чыгарганда аны жалгыз (') же кош (\") тырмакчага алышыңыз керек.",
"default_code": "print(\"Hello world!\")",
...
"next_exercise": 2,
"is_published": true,
"lesson": 1,
"unit_id": 1,
"track_id": 1,
"text_file_content": ""
},
{
"id": 2,
"name": "print() функциясы",
"entity_type": "Exercise",
"previous_exercise": 1,
"lecture": "Программалоо бул компьютерди колдонуучу...",
"instruction": "Басып чыгаруу функциясын колдонуп, терминалга...",
"hint": "Текстти басып чыгарганда аны жалгыз (') же кош (\") тырмакчага алышыңыз керек.",
"default_code": "print(\"Hello world!\")",
...
"next_exercise": 3,
"is_published": true,
"lesson": 1,
"unit_id": 1,
"track_id": 1,
"text_file_content": ""
}
],
"unit": 1
}
],
"is_published": true,
"track": 1
}
],
"is_published": true,
"programming_language": "Python",
"progress_data": {
"is_complete": false,
"is_in_progress": true
}
}
]For now, we also have similar endpoints for units, lessons, and exercises.
Submission of a code should be sent to /api/v1/user/submissions.
Happy coding!
Quirks
If you are having issues with cffi, try to upgrade pip (make sure env is activated): pip install --upgrade pip
Make sure you have a branch off of a fresh master.
How we git
Each task should be done within its own branch. For this, we keep our local master clean and synced. Let's walk throug an example. Imagine you are given a task related to creating a new page for editing an exercise. Your steps should be as follows:
- Make sure you are on the
masterbranch. When you issue the following command there should be an asterisk before the name of the branch* master:git branch - Make sure the branch is clean. After issue the following command you should see the text as follows:
git status- If it's not up to date, pull updates:
git pull origin master
- If it's not up to date, pull updates:
On branch master
Your branch is up to date with 'origin/master'.
nothing to commit, working tree clean
- Create a new branch:
git checkout -b create-exercise-editing-page - Write your code. Commit as often as possible. Educate yourself:
https://sethrobertson.github.io/GitBestPractices/ - After you are done with the task, create a Pull Request (PR):
- Push your code to the repository, to a new remote branch with an identical name:
git push origin create-exercise-editing-page - Go to the repository and refresh the page. You should see a button called
Create a pull request. Click on it and fill the form –– insert the task's URL to the text field and create a pull request. - Send your PR's URL to a person who is responsible for the code (team lead?).
- Do not merge until the PR is approved. When it's approved, make sure it has no conflicts.
- Push your code to the repository, to a new remote branch with an identical name:
- In case you have a conflicts (the same file or set of files was edited by you and your peer), in your machine switch to
master(please, make sure that you are really onmaster), pull updates (git pull origin master) and go to your branch:git checkout create-exercise-editing-pageand rebase from master:git rebase master. - Resolve conflicts. VSCode has a good tool, Github itself has its own one. A good video on the topic:
https://www.youtube.com/watch?v=JtIX3HJKwfo. If you are resloving the conflict locally, edit the files,git addthe resolved files, don't forget togit rebase --continueetc. Talk to your team lead in case you have questions. - Push the resolved code to your remote branch:
git push -f origin create-exercise-editing-page. See-f? It meansforce, that is, you should force-push to your branch, because your local one's git history is different than the remote one. - Make sure that after rebasing the code still works.
- If everything looks good, merge your branch to master.
- Woot!
JWT payload should have this data:
{
"first_name": "Murat",
"last_name": "Jumash",
"username": "muratjumash",
"email": "[email protected]",
"password": "$2y$10$s8yTdfhfYePKL7DoR4JZ0efYyPNHTPXak61UfaIpHdUM/GNoEIMlC"
}Please, refer to this page to get info about JWT: https://jwt.io
We set up bcrypt with 10 round in order to be able to accept users created in Laravel.
That is, a user's data (which was created in any Laravel website) can be encrypted into a JWT using the secret key specified here, will be created in this website. That means, they will be able to use their credentials.
For that to happen, a friendly website should use our JWT_SECRET to pass their user data to our site:
https://example.com/?token=jwt_token_with_payload
Rules