search

rianadon / Cosmos-Keyboards

Taking Keyboards to the Final Frontier
https://ryanis.cool/cosmos
GNU Affero General Public License v3.0
221 stars 24 forks source link

Docker compose setup for development #9

Closed lopar6 closed 8 months ago

lopar6 commented 8 months ago

This is a docker setup for development only, but it could easily be altered to be used for both development and deployment.

I ran into a few problems with running the make commands associated with docs but I didn't dig into too deeply. I simply do the steps for those make commands, instead of calling the make commands directly. If these commands change please also update the Dockerfile.

The golang gcc libgl1-mesa-dev packages are needed for the image to install gl.

On a side note, it would be nice to see a 'example.env' file so contributors know what env variable options there are.

vercel[bot] commented 8 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
cosmos-keyboards ✅ Ready (Inspect) Visit Preview Jan 22, 2024 4:28am
rianadon commented 8 months ago

Thanks for this!

How long does docker build spend on installing golang gcc libgl1-mesa-dev + the gl package? If it's more than a minute, I'm thinking maybe we should put those and the make keyboards command behind a build flag, since I imagine most contributors will be staying far far away from anything documentation related :D

Also what sort of issues did you have running the documentation-releated make commands? It would really be nice to re-use the make venv command. If the source command is causing issues, maybe edit the Makefile and replace source venv/bin/activate && pip with venv/bin/pip like you have in your Dockerfile?