Using docker for local development

[MarcKaufmann]

Since #lang conscript/local requires reimplementing lots of code, we are moving to docker instead to run congame on your machine for local development.

The following is how you can use it (it works on my machine):

1. Install docker (depends on OS you are on)
2. Clone the congame git repository to your machine
3. Start docker
4. In the terminal, go to the root of the repository, where the Dockerfile.local is (among many others)
5. Run the command docker compose up (make sure you are on a fast and stable internet connection before you do this)
6. Potentially wait a long time while lots of things are being downloaded and installed
7. If all goes well, then you have a server running on localhost:5100, so go to that url in your browser and you should see the congame homepage that you know and love
8. A user with email address "[email protected]" and password "admin" should already have been created for you. Try to log in with that username.

Now you can use this to upload studies manually. We are working on making that process more pleasant, but it's not there yet.

When you want to stop the server, hit ctrl-c where you ran docker compose up, or in your docker app you can start and stop the process as well in the future. Running docker compose up (from the command line or in the app) is near instantaneous once you have built it. Future updates may require that you rebuild, but even that should be substantially faster as not everything needs to be downloaded.

If you have questions on how to use it, or problems with any step, ask here - there are many steps where things can go wrong.

@otherjoel : Feel free to update or fix the recipe above. Once we have the easiest (one using the terminal less), we should add that to the documentation. It's fine to not document the docker stuff, but link to docker resources.

[alkrasnokutskaya]

I get an error and I'm scared to mess something up trying to fix it

[MarcKaufmann]

This has been resolved, looks like it was a problem with the cloning of the repo (some files were missing).

[MarcKaufmann]

Closing as the instructions are now part of the documentation - see https://docs.totalinsightmanagement.com/install-congame.html.