This project allows to collaborate around a map-based timeline, allowing to add 'content' to the timeline - fake tweets, instagram posts, wikipedia pages and others - to create an immersive story anchored in time and geographical location.
A simple demo can be found here https://akariv.github.io/speculatron/
This repo is intended for you to copy and modify based on your needs.
If you want to create an instance (or several instances) of this repo under the same account, you can use the "Create repo from template" option to 'copy' the repo. In this case, to get upstream updates go to the Actions tab and run the Fetch Latest Version (use carefully) workflow.
Choose a name for your code repository like <my-repo> (for example).
In the the package.json file replace the word speculatron with your repository name <my-repo> (for example).
The code contains a simple configuration file, which, after modifying, can be used to create a new instance of the app. The site is automatically built and deployed using GitHub Pages - all you need to do is connect it with your credentials and you're good to go.
The main configuration file is CONFIGURATION.ts.
You'll need to edit it with your own values and credentials.
export const AIRTABLE_BASE = '<your-airtable-base>';
export const AIRTABLE_API_KEY = '<your-airtable-api-key>';
export const AIRTABLE_DETAILS_FORM = '<your-airtable-details-form>';
export const MAPBOX_STYLE = '<your-mapbox-style>';
export const MAPBOX_ACCESS_TOKEN = '<your-mapbox-access-token>';The data for the timeline is stored in an AirTable base.
You can see the template of this base, which you can copy to your own account here: https://airtable.com/appuAa65B1iKwaXXb/tbll7x1j2P2mODiXk/viw5UCjE9GNZAOfZy
Once you have the base, add a read-only user to it (note: it needs to be a dedicated user that has only read-only access to that base - not a regular user).
Then, edit the config file with the values for the base and the API key.
Finally, the 'Content' table has a 'New Entry' form which you can use to add new entries to the timeline. Add its share link to the config file.
The map in this site uses MapBox. You can create a free account there, design you own map (or use one of the defaults).
Once you have it, add the style and access token to the config file.
For everything to work you need to enable Actions and Github Pages in your forked repository.
To deploy the site on a custom domain, add a CNAME file to the root of the repository containing the name of your domain. You also need to make some DNS modifications to point your domain to the GitHub Pages domain - please consult with the GitHub documentation for more information.
You will find in your GitHub repository two actions.
The one named 'Fetch Latest Version' can be run in order to fetch the latest version of the repository from upstream.
It will overwrite all the files in the repository - except the configuration file and package.json.
The action named 'Deploy' can be run manually in order to push an updated version of the site to the GitHub pages domain, in case there's something out of sync there (might happen after pulling the latest version).
This project was generated with Angular CLI version 14.0.1.
Run ng serve for a dev server. Navigate to http://localhost:4200/. The application will automatically reload if you change any of the source files.
Run ng build to build the project. The build artifacts will be stored in the dist/ directory.