Docker is a platform that serves to deliver software in packages called containers. Terrastories makes use of this to deliver the many facets included in the application in one easy package.
Download Docker:
| Windows 10 Pro | Windows 10 Home | |
|---|---|---|
| System Requirements | - 64 bit processor - 4GB system RAM - virtualization must be enabled |
Same as Windows 10 Pro, plus: - OS Version 2004 or higher (update your system if version is older) - Enable WSL 2 feature |
| Setup Instructions | https://docs.docker.com/docker-for-windows/install/ | https://docs.docker.com/docker-for-windows/install-windows-home/ |
There is no need to import any repositories at this point through docker.
To verify that your docker is up and running, click on the app or check the menu bar. Docker should show that it is running:
Create a fork of the Terrastories/terrastories repository. Now clone the repository locally to your computer.
Using the source-code editor of your choice, open the terrastories repository. There, a file can be found called .env.example.
Copy the contents of this file into a newly created file called .env (Do not change .env.example!).
Now navigate to a site called Mapbox create an account, and copy the mapbox access token (either your default public token or a new one you create) found under your acccount.
Navigate back to the .env file you created and replace where it says [your pk token here] with your mapbox access token.
Open Powershell and navigate to the terrastories repository and run:
docker-compose build
This will download and build all the docker images used in this project. Upon completion you should see output similar to:
...
Successfully tagged terrastories:latest
Within Powershell, run:
docker-compose up
If this fails, make sure all firewalls are turned off and you have a secure connection to the internet. If it continues to fail, check the common setup errors section.
This command should terminate with an output similar to:
terrastories_e2e_1 exited with code 0
Open another Powershell window and run the following command to setup:
docker-compose exec web bin/setup
This command runs a setup script that lives in bin/setup, which does:
- install ruby gems
- install javascript packages
- setup database See the script file for the details.
Enter localhost:3000 into your internet browser to view the application/
Everytime you want to open and use the application, make sure you have docker desktop running and run the following command into Powershell:
docker-compose up
You can view the running application at localhost:3000
It will take a moment to load when first opening the application
If you run into any problems getting the application to start, please check out a list of common errors & gotchas that we have put together here!
Additionally, feel free to join us in Slack here and find us in the channel #terrastories :) You can also post an issue and label it with question. We will get back to you ASAP!