Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create docker files and updated configs #19

Conversation

danoswaltCL
Copy link

@danoswaltCL danoswaltCL commented Dec 12, 2024

From the associated docker_local.README.md:

Mooclet Engine Local Development Setup

The docker_local setup is gives a way to quickly start up a mooclet-engine instance to greatly reduce the setup and startup time.

Launching docker_local.docker-compose.yml will:

  • Install all dependencies
  • Create an reusable image of the API
  • Run the Mooclet API and a postgres DB in a container
  • Create a super-user mooclet for immediate login

Prerequisites

  • Docker
  • Docker Compose

Setup Instructions

1. Clone the Repository (if you haven't already)

git clone https://github.com/Intelligent-Adaptive-Interventions-Lab/mooclet-engine.git
cd mooclet-engine

2. Environment Configuration

Copy secure.py.example

Copy the example secure configuration (or modify your existing secure.py to include the docker_local settings):

cp mooclet_engine/settings/secure.py.example mooclet_engine/settings/secure.py

Edit secure.py to use docker_local as default for local database:

ACTIVE_DATABASE_CONFIG = 'docker_local'

Copy docker_local.env.example env File

These values are used in various spots in the docker setup. No edit needed unless you would like different values.

cp mooclet_engine/docker_local.env.example mooclet_engine/docker_local.env

3. Run it!

docker-compose -f docker_local.docker-compose.yml up --build

To stop the Containers, do:

docker-compose -f docker_local.docker-compose.yml down

4. Accessing the Application and get API token

Navigate to Tokens to create a token for your API calls.

@danoswaltCL danoswaltCL closed this Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant