Documentation for this project can be found here:
https://verbose-equals-true.gitlab.io/django-postgres-vue-gitlab-ecs/
First, copy .env.template to a new file in the project's root directory called .env. This file will be read by docker-compose in the next step. Adjust any of the values in this file if needed, or add new variables for any secret information you need to pass to docker-compose (or to docker containers).
To use social sign on in development, you will need to create an application with the given provider.
Go to https://github.com/settings/applications/new, and add the following:
- Application Name: A name for the development application, such as
My App Dev - Homepage URL:
http://localhost - Application description: (optional)
- Authorization callback URL
http://localhost/auth/github/callback(this route is defined inquasar/src/router/routes.js)
In the .env file, add the Client ID of your GitHub OAuth App as the GITHUB_KEY variable, and add the Client Secret as the GITHUB_SECRET variable.
docker-compose upOpen http://localhost in your browser.
You can specify environment variables for docker-compose by adding an .env file to the root of the project based on .env.template.
This project uses VuePress for documentation. To view the documentation site locally, run the following command:
docker-compose -f compose/docs.yml up --buildThis will make the docs available at http://localhost:8082/docs/. Hot-reloading through websockets is supported, so changes will show up as they are saved in your code editor.
With all containers running, run the following commands:
docker exec -it backend bash
# cd notebooks/
# ../manage.py shell_plus --notebook
or use this single command:
docker exec -it backend bash -c 'cd notebooks && ../manage.py shell_plus --notebook'