-
Notifications
You must be signed in to change notification settings - Fork 0
Onboarding
The CCRP offers two options to help you get set up and started with the Colouring Cities platform.
This involves creating a clone of the Colouring Core repository for you and your team.
We also create a Team for you on GitHub, which will give you appropriate access to everything you need on the platform, including:
- Full control of your team's repository
- Access to The Core Repository, so you can keep up to date with the latest Core updates and contribute to the Core Platform.
- Access to the Technical Manual (you are here!)
- Access to other Colouring Cities sites/tools, such as the Impact Studies site, so you can contribute to other parts of the programme too.
For those administrating the CCRP Organisation, this involves the following steps:
- Create a team for the new country as a sub-team of the CCRP Country Teams team. This will grant all members of that new team access to the relevant Core repositories.
- Create a fork of the Core repository - making sure to keep it within the Colouring Cities organisation - and rename it to colouring-[country]. Make sure to give the new team 'Maintain' access to that repository.
This process takes approximately 10 minutes, assuming we have a GitHub username(s) of at least one person who will be responsible for managing the team.
We may have some limited capacity to create preview images/videsos. If you send us the footprints for all of the buildings in the city/region/country that you are interested in colouring, then we can set up a working prototype version of the Colouring Cities platform. This would be on a local Virtual Machine (VM) and not accessible online, but we could do a live demo over Zoom. Alternatively, we could create screenshots or a short video of the site being used for you to share with colleagues, funders and other shareholders.
This can be done in a day, if we have the building footprints (and, ideally, some sample data - but we can set up a demo with placeholder data).
We provide full instructions and documentation on how to set up your Colouring Citities platform, set up the database, import building footprints and start uploading data into the platform. This is an ideal way for engineers to begin to familiarise themselves with the tool. If you encounter any problems, then we can offer support (and hope you will collaborate with us to update the documentation for our tools and processes).
Alternatively, we currently can do some of the additional setup for you. This includes initialising the database and footprints. This will leave you with a platform that is ready for use.
Note: To do that, you must grant us access to the server/virtual machine where the platform is hosted, as well as the building footprints.
Our colleagues are currently working on creating a containerised version of the Colouring Cities platform using Docker.
Part B should only take a couple of hours.
We can also offer additional support. We can arrange a Zoom training session to introduce you to the tool and help you get started. We can also offer online support to help with any issues.
We are also currently updating our documentation and working on creating a series of videos to help. If you spot any problems with the documentation, we'd appreciate your help in fixing/updating it. We hope that the additional materials will be available soon.
Please note, our engineers work part-time on the project and may not always be able to respond right away.
Once the server is up and running, we can set up a subdomain for you on ColouringCities.org. This allows you to have a custom domain name and make it clear that you are officially part of the Colouring Cities programme. Just send us the IP address of your server, and you can have a URL, such as: