Sample instructions for setting up dependencies and installs.

Clone the repository and navigate into the directory:

git clone https://URL.git
cd REPO/

Install Android Studio and import the project.

Generate a Google Maps SDK API key (step 1).

Duplicate the Google Maps API key template file to hold the API key:

cp Rebuild/app/src/debug/res/values/google_maps_api_template.xml Rebuild/app/src/debug/res/values/google_maps_api.xml

cp Rebuild/app/src/release/res/values/google_maps_api_template.xml Rebuild/app/src/release/res/values/google_maps_api.xml

Choose the debug/ folder for development, or the release/ folder for release.

In the new file google_maps_api.xml, uncomment the line with the key and replace the value of the placeholder with your API key. This new file will not be tracked by Git.

Build and run the Android application on a physical or virtual device.

Create a new file in the root directory to hold the secure keystore details:

cp keystore.properties.template keystore.properties

This file will be ignored by Git. Set your keystore information in this file.

Under Build, click Select Build Variant.

In the Build Variants view which appears, change the Active Build Variant from debug to release.

Build the application normally to your phone. The keystore credentials will be verified and applied.

Under Build, click Generate Signed Bundle / APK.

Follow the instructions, inputting your keystore path and credentials, to create a signed app which can be uploaded to the app store.

Install the Heroku command line interface by following these instructions.

Login to Heroku:

heroku login

Create a Heroku application with your preferred app name:

heroku apps:create APPNAME

Install Node.js (which comes with NPM).

Install the required NPM dependencies:

npm install

Install the Angular command-line interface:

npm install -g @angular/cli

To start up the website locally, run:

ng serve

The app will automatically reload if you change any of the source files.

To build the website generically for deployment, run:

ng build

Install Golang.

Setup the dependencies:

go get -t ./...

Build the server:

go build

Run the executable:

,/EXEC

Install Node.js (which comes with NPM).

Install the necessary NPM packages:

npm install

Start the server locally:

npm start

Follow these instructions to create a new Google Cloud Platform project and enable the Google Sheets API.

Download the Client JSON file and rename it to credentials.json. Place it in this directory (it will be ignored by Git).

Start the server locally:

npm start

Google will guide you through a process to authenticate the server. This will only occur the first time.

After creating the Google Cloud Platform project in Setup above, create a new set of credentials for the Service Account. Download the secret file and keep it safe.

Create a Heroku application with whichever method you prefer. In your deployment environment, set the following environment variables using values from the secret file:

Ensure that the client email has access to the Sheet; share access to it manually if necessary.

Required packages: texlive texlive-bibtex-extra texlive-publishers

Install the required packages:

sudo apt-get install texlive

To build the output PDF, run pdfTeX twice:

pdflatex $FILENAME
pdflatex $FILENAME

Install the required packages:

sudo apt-get install texlive-bibtex-extra texlive-publishers

Build the bibliography (the .bib file):

bibtex $FILENAME

Then build the output PDF again, twice:

pdflatex $FILENAME
pdflatex $FILENAME

If Python 3 is not yet installed, then install the relevant packages:

sudo apt-get install python3 python3-pip

Install the PIP dependencies:

pip3 install PACKAGES

pip3 install -r requirements.txt

Install Virtualenv and create an environment named venv (or any name you prefer) within your project directory:

pip3 install virtualenv
cd PROJECT_DIR/
virtualenv venv

Before installing any other packages from the project, activate the virtual environment to isolate your environment for all following commands:

source venv/bin/activate

If on Windows, run the script directly instead:

./venv/Scripts/activate

Run all Python and PIP commands here.

To deactivate the isolated virtual environment and return to the original environment, either close the console window or run the following command:

deactivate

Flask is installed by the PIP commands above.

For all following commands, flask can be replaced with python3 -m flask if the Flask executable is not available.

Migrate the database to the newest version:

flask db upgrade

Start the server with either one of the following commands:

python3 app.py

flask run

The server will be available on port 5000 (http://127.0.0.1:5000).

Install MySQL.

Configure access to the root account on MySQL so that you can login with the following command:

mysql -u root -p YOUR_PASSWORD_HERE

Exit the MySQL prompt by typing:

exit

For reference, see this sample guide from DigitalOcean for Debian-based systems.

Install Yarn.

Install the necessary packages:

yarn install

Start the server locally:

yarn start

The server will be available on port 3000 (http://127.0.0.1:3000).

To build deployable files, edit the value homepage in package.json to be the URL where the web application will be hosted, so that the page can resolve the correct URL to its resources.

Build the files:

yarn build

The completed files will be ready for deployment at directory build/.