Our docker implementation is incomplete and may not work smoothly. Please kindly report any issues!
These prerequisites assume you're working on an operating system supported by Docker.
Docker is available for many different operating systems. We recommend you follow the Docker CE install guide which illustrates multiple installation options for each OS.
You're also going to need Docker Compose, to start multiple containers. We recommend you follow the Docker Compose install guide as well.
git clone https://github.com/<your-username>/dev.to.git
Set up your environment variables/secrets
Envfile. This file lists all the
ENVvariables we use and provides a fake default for any missing keys. You'll need to get your own free Algolia credentials to get your development environment running.
For any key that you wish to enter/replace:
config/application.ymlby copying from the provided template (ie. with bash:
cp config/sample_application.yml config/application.yml). This is a personal file that is ignored in git.
GITHUB_KEY: "SOME_REAL_SECURE_KEY_HERE" GITHUB_SECRET: "ANOTHER_REAL_SECURE_KEY_HERE"
You do not need "real" keys for basic development. Some features require certain keys, so you may be able to add them as you go.
docker-compose run web rails db:setup
docker-compose run web yarn install
DEV provides a
docker-run.sh script which can be used to run the Docker app with custom options.
Please execute the script itself to view all additional options: