Development¶

Prerequisites¶

You need the following libraries and/or programs:

Developers can follow the following steps to set up the project on their local development machine.

You can retrieve the source code using the following command:

$ git clone git@github.com:VNG-realisatie/documenten-api.git drc

Note: You can also use the HTTPS syntax:

$ git clone https://github.com/VNG-realisatie/documenten-api.git drc

Create the virtual environment:

$ virtualenv -p /usr/bin/python3.x ./env

Source the activate script in your virtual environment to enable it:
```
$ source env/bin/activate
```

Install all the required libraries:

(env) $ pip install -r requirements/dev.txt

Note

You can put local, machine specific setting changes in src/drc/conf/local.py. These settings are NOT checked into version control.

Create a superuser to access the management interface:
```
(env) $ python src/manage.py createsuperuser
```
You can now run your installation and point your browser to the address given by this command:
```
(env) $ python src/manage.py runserver
```

Install Javascript modules:
```
$ npm install
```
Launch the schema generation tool:
```
generate-schema
```
The resulting openapi.yaml and swagger2.0.json files can be visualized with Swagger

When updating an existing installation:

Update the code and libraries:

(env) $ git pull
(env) $ pip install -r requirements/dev.txt
(env) $ npm install