Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
AlekSIS-Core
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Service Desk
Analyze
Contributor analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
AlekSIS®
Official
AlekSIS-Core
Commits
40281940
Unverified
Commit
40281940
authored
5 years ago
by
Nik | Klampfradler
Browse files
Options
Downloads
Patches
Plain Diff
Add first docs on how to setup dev environment, advances
#12
.
parent
d5c1089f
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/dev/setup.rst
+57
-0
57 additions, 0 deletions
docs/dev/setup.rst
docs/index.rst
+1
-0
1 addition, 0 deletions
docs/index.rst
with
58 additions
and
0 deletions
docs/dev/setup.rst
0 → 100644
+
57
−
0
View file @
40281940
Setting up the development environment
======================================
BiscuIT and all official apps use `Poetry`_ to manage virtualenvs and
dependencies. You should make yourself a bit confortable with poetry
by reading its documentation.
Poetry makes a lot of stuff very easy, especially managing a virtual
environment that contains BiscuIT and everything you need to run the
framework and selected apps.
Get the source tree
-------------------
To download BiscuIT and all officially bundled apps in their
development version, use Git like so::
git clone --recurse-submodules https://edugit.org/Teckids/BiscuIT/BiscuIT-ng
If you do not want to download the bundled apps, leave out the
``--recurse-submodules`` option.
Get Poetry
----------
Make sure to have Poetry installed like described in its
documentation. Right now, we encourage using pip to install Poetry
once system-wide (this will change once distributions pick up
Poetry). On Debian, for example, this would be done with::
sudo apt install python3-pip
sudo pip3 install poetry
You can use any other of the `Poetry installation methods`_.
Install BiscuIT-ng in its own virtual environment
-------------------------------------------------
Poetry will automatically manage virtual environments per project, so
installing BiscuIT is a matter of::
poetry install
Running commands in the virtual environment
-------------------------------------------
To run commands in the virtual environment, use Poetry's ``run``
command::
poetry run ./manage.py runserver
.. _Poetry: https://poetry.eustace.io/
.. _Poetry installation methods: https://poetry.eustace.io/docs/#installation
This diff is collapsed.
Click to expand it.
docs/index.rst
+
1
−
0
View file @
40281940
...
...
@@ -10,6 +10,7 @@ Welcome to BiscuIT's documentation!
:maxdepth: 2
:caption: Contents:
dev/setup
Indices and tables
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment