README.md

FriendHub - Your Location Sharing Service

FriendHub is a Django-based location-sharing application that allows users to connect with friends, share their real-time locations, and visualize how much of their location is visible to their friends.

Note: This group project is created for the Software Engineer Class at Chico State, please do not create any pull requests as they will not be accepted.

Setup

The first thing to do is to clone the repository:

$ git clone git@github.com:ChicoState/FriendHub.git
$ cd FriendHub

Get your Google Maps JS API Key. Then create a .env in the current directory & add your API key inside it like this:

$ API_KEY="<KEY>"

Create a virtual environment to install dependencies in and activate it:

$ pip install virtualenv (if not installed already)
$ virtualenv env
$ source env/bin/activate

Then install the dependencies:

(env)$ pip install -r requirements.txt

Note the (env) in front of the prompt. This indicates that this terminal session operates in a virtual environment set up by virtualenv2.

Once pip has finished downloading the dependencies:

(env)$ python manage.py migrate
(env)$ python manage.py runserver

And navigate to http://127.0.0.1:8000/.

To leave virtual env:

(env)$ deactive