Gitlab Community Edition Instance

Skip to content
Snippets Groups Projects
Verified Commit a95dd424 authored by Jan Maximilian Michal's avatar Jan Maximilian Michal
Browse files

Updated README.md. Closes #63.

parent 810ffed2
Branches
Tags
1 merge request!19Whitenoise
Pipeline #
......@@ -5,7 +5,8 @@ VENV_PATH = .venv
.PHONY: run install migrations-check isort isort-check test
.venv:
python3.6 -m venv $(VENV_PATH)
@python3.6 -m venv $(VENV_PATH) || exit 1
@echo To enter: source .venv/bin/activate
run:
python manage.py runserver 0.0.0.0:8000
......
......@@ -41,8 +41,8 @@ To set up a new instance perform the following steps:
1. Create a virtual environment with a Python3.6 interpreter and
activate it. It works like this:
virtualenv -p python3.6 env
source env/bin/activate
make .venv
source .venv/bin/activate
Just type `deactivate` the get out.
......@@ -50,20 +50,13 @@ To set up a new instance perform the following steps:
export DJANGO_DEV=True
3. Install dependencies:
pip install -r backend/requirements.txt
yarn --cwd frontend/
yarn --cwd backend/
or alternatively with the make task:
3. Install backend dependencies with:
make install
Some systems (like Ubuntu Xenial) come with a preinstalled "yarn -
scenario testing of Unix command line tools". Using this will
**not** work. The [yarn package
manager](<https://yarnpkg.com/en/docs/install>) is needed.
**not** work. The [yarn package manager](<https://yarnpkg.com/en/docs/install>) is needed.
4. Set up a Postgres 9.5 database. If you have docker installed the
easiest way is to just run it in a docker container, like this:
......@@ -71,12 +64,11 @@ To set up a new instance perform the following steps:
docker run -d --rm --name postgres -p 5432:5432 postgres:9.5
Alternatively, take a look at the Makefile targets that should make your
life easier.
life easier, e.g `make db`.
And apply database migrations:
And apply database migrations once the database is up:
python manage.py migrate
python manage.py loaddata core/fixtures/testdata-groups.json
5. Create a superuser if necessary:
......@@ -85,18 +77,12 @@ To set up a new instance perform the following steps:
More users can be added in the admin interface. You should be able
to reach it via <http://localhost:8000/admin>.
6. To import some test data in order to see how the application might look like
run:
make loadexamples
7. Everything is set. You can start the development server with:
python manage.py runserver
or just:
make run
8. Congratulations! Your backend should now be up an running. To setup the frontend
see the README in the `frontend` folder.
Testing
-------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment