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
GitLab community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
AlekSIS®
Official
AlekSIS-Core
Commits
411eb2a6
Verified
Commit
411eb2a6
authored
Dec 8, 2019
by
Nik | Klampfradler
Browse files
Options
Downloads
Patches
Plain Diff
Update development setup instructions
parent
f84866f0
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/dev/01_setup.rst
+30
-6
30 additions, 6 deletions
docs/dev/01_setup.rst
docs/dev/02_install_apps.rst
+2
-8
2 additions, 8 deletions
docs/dev/02_install_apps.rst
docs/dev/03_run.rst
+0
-10
0 additions, 10 deletions
docs/dev/03_run.rst
with
32 additions
and
24 deletions
docs/dev/01_setup.rst
+
30
−
6
View file @
411eb2a6
...
...
@@ -9,6 +9,7 @@ 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.
Also, `Yarn`_ is needed to resolve JavaScript dependencies.
Get the source tree
-------------------
...
...
@@ -16,7 +17,7 @@ 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
git clone --recurse-submodules https://edugit.org/BiscuIT/BiscuIT-ng
If you do not want to download the bundled apps, leave out the
``--recurse-submodules`` option.
...
...
@@ -45,13 +46,36 @@ installing BiscuIT is a matter of::
poetry install
R
unning commands in the virtual environment
-------------
------------------------------
R
egular tasks
-------------
To run commands in the virtual environment, use Poetry's ``run``
c
om
mand:
:
After making changes to the environment, e.g. installing apps or updates,
s
om
e maintenance tasks need to be done
:
poetry run ./manage.py runserver
1. Download and install JavaScript dependencies
2. Collect static files
3. Run database migrations
All three steps can be done with the ``poetry run`` command and
``manage.py``::
poetry run ./manage.py yarn install
poetry run ./manage.py collectstatic
poetry run ./manage.py migrate
(You might need database settings for the `migrate` command; see below.)
Running the development server
------------------------------
The development server can be started using Django's ``runserver`` command.
You can either configure BiscuIT like in a production environment, or pass
basic settings in as environment variable. Here is an example that runs the
development server against a local PostgreSQL database with password
`biscuit` (all else remains default) and with the `debug` setting enabled::
BISCUIT_debug=true BISCUIT_database__password=biscuit poetry run ./manage.py runserver
.. _Poetry: https://poetry.eustace.io/
.. _Poetry installation methods: https://poetry.eustace.io/docs/#installation
.. _Yarn: https://yarnpkg.com
This diff is collapsed.
Click to expand it.
docs/dev/02_install_apps.rst
+
2
−
8
View file @
411eb2a6
...
...
@@ -17,11 +17,5 @@ This will install the Exlibris app (library management) app by using a
shell for first ``cd``'ing into the app directory and then using
poetry to install the app.
Migrate the database
--------------------
After installing or updating any apps, the database must be updated as
well by running Django's ``migrate`` command::
poetry run ./manage.py migrate
DO not forget to run the maintenance tasks described earlier after
installign any app.
This diff is collapsed.
Click to expand it.
docs/dev/03_run.rst
deleted
100644 → 0
+
0
−
10
View file @
f84866f0
Running BiscuIT in development mode
===================================
Using Django's development server
---------------------------------
After you installed the framework and all desired apps and migrated
the database, you are ready to run BiscuIT::
poetry run ./manage.py runserver
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