Quickstart

A simple docker-compose.yml file is available to get the APIs up and running in minutes. This file has some convenience settings to get started quickly and these should never be used for anything besides testing:

• A default secret is set in the SECRET_KEY environment variable.

• A predefined database and database account is used.

• API authorizations are disabled.

With the above remarks in mind, let’s go:

Open Object

1. Create a project folder:

   $ mkdir open-object
   $ cd open-object
   

2. Download the docker-compose file:

   LinuxWindows Powershell 3

   $ wget https://raw.githubusercontent.com/maykinmedia/open-object/master/docker-compose.yml
   

3. Start the Docker containers:

   $ docker compose -f docker-compose-qs.yml up -d --no-build
   

4. Import a demo set of objects (linking to the demo objecttypes):

   $ docker compose exec web src/manage.py loaddata demodata
   

5. Create a superuser

   $ docker compose exec web src/manage.py createsuperuser
   

6. Retrieve an object via the Open Object API in your webbrowser:

   http://localhost:8000/api/v2/objects/
   

After you have Open Object running you can configure Authentication, Authorization and use the API’s.