pravinavisakan / spur

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Spur

An easy way to find small events close to you.

Directory Structure

Spur/navigation: contains react navigation components
Spur/screens: contains the screens shown to the users
Spur/components: contains the various components used by the screens.

Installation/Run instructions

Follow the instructions here to install expo-cli
https://facebook.github.io/react-native/docs/getting-started

After expo-cli is installed, enter the Spur root directory and run
npm install to install dependencies
npm start to start the project

You will need an android emulator running to run the project, which the link above explains how to install, or install the Expo app on your phone to run it on your physical device.

You will also need to setup the database and APIs, which is detailed in the next section.

Database/API Setup

Spur runs on Firebase Real-time Database. To run a local copy of Spur, create a new real-time database, then rename FirebaseConfigExample.js to FirebaseConfig.js inside Spur/constants and fill in the values in the config to the values provided by Google.

Inside Spur/app.json, fill in your Google Maps API key requested from Google.

The Google Maps API key also needs to be placed inside Spur/screens/CreateScreen.js, on line 66, specifically in the function call Geocoder.init("API KEY HERE");.

Tests

Testing was done with Jest and can be run with the command npm test. Tests can be found in the tests branch, located within the branch at Spur/__tests__

The specific tests are:
BrowseScreen-test.js
Constants-test.js
CreateScreen-test.js
StyledText-test.js
UserLoginScreen-test.js
ProfileScreen-test.js
EditProfile-test.js
OtherProfileScreen-test.js
ViewEvent-test.js
ChatroomScreen-test.js
ChatScreen-test.js
DatePick-test.js
JoinButton-test.js

Relevant Links

About


Languages

Language:JavaScript 100.0%