Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 3.11 KB

README.md

File metadata and controls

79 lines (53 loc) · 3.11 KB

SafeMaps CircleCI

Description: Illini SafeMaps is your real-time safety companion. With Illini SafeMaps, you can navigate safely around the U of I campus by viewing the locations of past crimes, police stations, emergency phones, running buses, open businesses and streetlights. This app also enables you to be notified of the safety and health resources near you so you can stay safe and healthy at U of I. Lastly, students can access SafeWalks and SafeRides immediately through our app when they feel unsafe on campus.

Product Resources

Design Resources

Backend Resources

Tech Stack

We split this application into Frontend and Backend services. The backend is Flask server using python 3.7 and pipenv with MongoDB, a NoSQL database, as our choice of data store. The Frontend is built with React Native and Expo, which enables our app to run on any type of mobile device.

Application Structure

  • c2tc-mobile: frontend top directory
  • backend: backend top directory

Specific Documentation is given inside the c2tc-mobile and backend folders.

Development Setup

Dependencies

  • Node.js 8.x.x
  • Python 3.7
  • Pipenv

To run the flask server in the backend

cd backend
pipenv install           # install dependencies
pipenv shell
python manage.py runserver

To run the frontend

cd c2tc-mobile
yarn                         # install dependencies
yarn global add expo-cli     # do this step if you have never used expo before.
# Install the Expo Mobile App on phone if you have never used expo before.
expo start
# Scan QR code with phone (use camera if you have an iphone and use expo app if you have an android.)

Note: if you prefer using npm, use npm instead of yarn in commands provided above

Team

Software Devs Fall 2018

Software Devs Spring 2019