MapStory.org is the free atlas of change that everyone can edit. We are a community, not a company, working to organize humanity’s shared knowledge about how the world evolves geographically over time, and to make this knowledge easily accessible as an open educational resource.
The MapStory community’s work breaks down into 3 big tasks. We call them the “3 Cs”. First, once you’ve created a profile, you can collect spatio-temporal data and import it. We call each dataset imported into MapStory.org a “StoryLayer”. Second you can compose MapStories that provide nuanced understanding of historical change by combining StoryLayers and other narrative elements, like images, text, or video. Finally, you can curate the accuracy and quality of content presented in MapStory.org by adding ratings, checking metadata, making comments and committing version edits to the actual StoryLayers themselves, much like you might edit a Wikipedia page.
Diskspace: - approx 20Gb of disk space is required for the full software stack and runtime data storage for testing. More may be required depending on data capacity. TBD: sizing guidelines for production deployments
Memory: - Geonode recommends 6GB of memory. At least 2GB seems necessary to build the deployment using docker. [http://docs.geonode.org/en/master/tutorials/install_and_admin/quick_install.html#recommended-minimum-system-requirements]
OS: These instructions assume a UNIX environment you can access via HTTP, or a Windows Pro desktop environment with Hyper-V and Docker-CE https://store.docker.com/editions/community/docker-ce-desktop-windows are required.
Note Docker-CE has some issues with disk permissions and may require some intervention - see [https://stackoverflow.com/questions/43880764/in-docker-for-windows-permissions-denied-for-mkdir-chown]
A draft setup using Vagrant and virtualbox to use a UNIX VM on other host environments is provided, but not yet fully debugged. Using DockerTools may also be viable for Windows HOME but this is also not currently building correctly and is not a priority to debug, however contributions are welcome. Other environments should provide specific instructions in README-.md
Software: Make sure these components are installed:
git
docker
docker-compose
Mapstory creates an appication accessible via HTTP. TBD: identify any network access requirements for management procedures such as codebase updates
Add the following to your /etc/hosts file
127.0.0.1 docker
::1 docker
Todo: does this work if there are multiple docker containers running on the machine?
TBD
TBD
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. Start by forking the mapstory repository to your own Github account, and then cloning that repository to your local development environment.
git clone https://www.github.com/<your-username>/mapstory
Run the following commands to start up the docker containers.
git submodule update --init --recursive
docker-compose pull
docker-compose up -d
Your local site should now be available at http://docker/.
Additional information about using the docker build is available at our Docker README.
- Python 2.7 - The primary backend development language.
- Django 1.8.7 - The back end web development framework.
- AngularJS 1.6 - The front end web development framework.
Please read How to Contribute for details on our code of conduct, and the process for submitting pull requests to us.
Please review our Contributor Guides for best practices and style guides before contributing to the project.