The dojo platform is an HES-SO that is an online tool built to help practice programming by
allowing users to propose assignments and perform them as exercises.
The tool is very flexible and allows for proposing exercises for any language
and does not impose any limitation on a framework to be heavily relying
on Docker and Gitlab. These tools used in combination allow for automatic
correction of assignments in order to give immediate feedback to users
performing exercises. Solved exercises can then be shared among the community
of users such that they can inspire other users or give hints on ways to solve
a given exercise.
## Getting started
The two major concepts of the platform are the **assignments** and the **exercises**.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
The principal way to interact with the Dojo platform is currently the `dojo` CLI.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
### The assignment
An assignment is written by a user that wants to propose an exercise. It is typically composed of a written description of the work to be performed,
and tests that must be passed once the exercise is successfully performed (and some configuration files for the infrastructure of the tests
such as docker files). At its core, an assignment is
nothing else than a git repository that can be forked in the form of an exercise and modified using standard git commands.
## Add your files
In the future a dependency tree of assignments can be created, as well as tagging for filtering purposes.
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
### The exercise
An exercise is an instance of an assignment which the learner will modify in order to make it pass the automatic tests.
It can be run locally on any user's machine using the dojo CLI. When the exercise is completed
it is pushed on the dojo where the CI/CD tools of Gitlab can evaluate it automatically and
notify the dojo platform of the result. The exercises can then be shared with other users
in order to propose a wide variety of solutions and can be a base for discussion among users
## Main projects that are part of the Dojo platform
*[DojoBackendAPI](https://gitedu.hesge.ch/dojo_project/projects/backend/dojobackendapi): The API backend of the dojo platform
*[DojoExerciseChecker](https://gitedu.hesge.ch/dojo_project/projects/pipelines/dojoexercisechecker): The app (bundled in a Docker image) that check if an exercise have been solved correctly
*[DojoExerciseChecker](https://gitedu.hesge.ch/dojo_project/projects/pipelines/dojoassignmentchecker): The app (bundled in a Docker image) that check if an assignment is valid
*[DojoCLI](https://gitedu.hesge.ch/dojo_project/projects/ui/dojocli): The command line interface to interact with the dojo platform
*[DojoWeb](https://gitedu.hesge.ch/dojo_project/projects/ui/dojoweb): The frontend of the dojo platform (coming soon)
-[ ] [Set up project integrations](https://gitedu.hesge.ch/dojo_project/dojo/-/settings/integrations)
## Collaborate with your team
## How to use Dojo ?
The principal way to interact with the Dojo platform is currently the `dojo` CLI.
You can find all the documentation in the [Wiki of the CLI project](https://gitedu.hesge.ch/dojo_project/projects/ui/dojocli/-/wikis/home).
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
Use the built-in continuous integration in GitLab.
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
* If you are a student that search help for a specific assignment, please contact your teaching staff.
* For any other questions, feature proposals or bug reports, please open an issue on the [Dojo Issues project](https://githepia.hesge.ch/dojo_project/issues/-/issues) on Gitlab and don't forget tags.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
## Roadmap
You can find the roadmap (the deadlines are not available) of the project in the [Dojo Issues project](https://githepia.hesge.ch/dojo_project/issues/-/boards) on Gitlab.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Contacts / Developers
*[Michaël Minelli](mailto:dojo@minelli.me): Main contact
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
Most parts (e.g. all of the source code) of the project are licensed under the AGPLv3 license.
Some parts (e.g. internal documentation) are private.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
The project is currently in test stage and is actively developed.
