A web application for the UWA Historical Society. The app will use a map of the UWA Crawley Campus to orientate new students and utilise excerpts from the UWAHS Oral Collection in the History Mode.
The user can look around the map and view points of interest. Points of interest can contain a description, images and oral histories.
The admins (UWAHS Volunteers) can add points of interest for the users.
Find the meeting agendas and minutes at the wiki.
npm install
to install dependencies. Required to do before anything else.npm start
to run in development mode. Open http://localhost:3000 to view it in the browser.npm test
to launch the test runner in interactive watch mode.npm run build
to build the app for production. Find it in the/build
folder.
- Install NodeJS
git clone https://github.com/LightXEthan/uwahs-campus-map
to download the filesnpm install
to install the dependencies, node_modules file will appear with the dependencies- Rename the
.env_template
file to.env
and add the project configuration keys found in the Firebase project settings. See below for more info. npm start
to start a local server
The env_template
file is for the api keys, add the api keys and rename the file to .env
, Getting api keys:
Firebase API
- Go to the console: https://console.firebase.google.com
- Add a new project
- Go to the project settings: http://prntscr.com/ox786z.
- Find the Web API Key, scroll down for the project config
- Do
firebase login
in console
Google Maps API
- Go to the console: https://console.cloud.google.com
- Add Google Maps JavaScript API
- Go to library: http://prntscr.com/p09y44
- Enable JavaScript Maps API
- Go to credentials and find the API Key, a verified billing account is needed to increase the number of map loads from one. To verify, a credit card is needed. There is no upfront costs. Otherwise, the map will have a ‘For Development Purposes’ watermark.
- Follow the Firebase documentation Get started with Firebase for web to create and register a Firebase project.
npm i -g firebase-tools
to install the Firebase CLI.firebase login
to connect your machine to Firebase.firebase init
to initialize your Firebase project in this app. Selecthosting
when prompted.- Ensure you have the
.env
file with the project configuration keys found in the Firebase project settings. - Add an API key for Google Maps Google Cloud Platform, more info can be found in the dev documentation
npm run build
to build the React app.- Modify the
public
key-value pair infirebase.json
to"public": "build"
. firebase deploy
to deploy.