- Any device running MacOS: i.e. a MacBook Pro / MacBook Air / Mac Mini / Mac Studio / iMac. The setup instructions below may also work on Linux, but they aren't tested on that platform.
- Git
- Docker desktop
- VSCode with the Dev Containers extension installed
- BitWarden CLI
- Open a terminal (either the MacOS terminal or a terminal window in VSCode) and run the following commands:
git clone [email protected]:commonknowledge/mapped.git
cd mapped
bin/download_env_files.sh-
If you haven't already done so, open the project folder in VSCode (File menu -> Open folder). Ignore any errors from VSCode at this point. You will receive a notification like this:
Click "reopen in container". If that doesn't happen, press Cmd+Shift+Pto open the command palette, and type "reopen in container" to find the "Dev Containers: Reopen in Container" option. -
There will be an error from the Apollo GraphQL extension that can be ignored (the extension does not work until Mapped is running).
-
Wait for the Dev Containers to set up. This will take less than 10 minutes.
-
In the "Run and Debug" section of the VSCode left-hand navigation, click the "Run Mapped!" configuration to start the Mapped application.
-
Visit http://localhost:3000 in your browser to access Mapped.
- Log in to the Mapped front end. The username and password are
adminandpassword. - There are 3 available data sources: "Seed Member List", "Seed Custom Data", and "Seed Events".
- The "Seed Member List" data source has a mapping that populates the Constituency and Element fields in the AirTable.
- There is a map report called "Test map report" displaying constituencies and MPs.
- The hub is available at hub.localhost:3000.
- The hub has some minimal content on the homepage, and a working pledge map.
- You can edit the hub through the Mapped dashboard (i.e. localhost:3000/hub/editor).
You can also log in to the Django and Wagtail admin systems. The
username and password are admin and password.
Wiki coming soon... In the meantime, you can find some more documentation and troubleshooting instructions here.
