https://github.com/ryanabx/team6-safelivingapp

A website to compare safety metrics across cities - Made by students of the University of Tulsa's CS-4503 and CS-4513 Senior Software Project Classes
https://github.com/ryanabx/team6-safelivingapp

university-of-tulsa

Last synced: about 1 month ago
JSON representation

A website to compare safety metrics across cities - Made by students of the University of Tulsa's CS-4503 and CS-4513 Senior Software Project Classes

• Host: GitHub
• URL: https://github.com/ryanabx/team6-safelivingapp
• Owner: ryanabx
• Created: 2021-09-07T17:30:37.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-11T03:54:30.000Z (over 2 years ago)
• Last Synced: 2024-04-28T02:10:56.450Z (7 months ago)
• Topics: university-of-tulsa
• Language: Python
• Homepage:
• Size: 49.9 MB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Save Living App



The Safe Living App Website is a website which can help you compare many factors when determining your next place to live! The website compares FBI Crime Data along with several other data points in order to find the best match for a user's ideal city!

(This project was developed for CS-4503 and CS-4513 Senior Software Project at the University of Tulsa from FA2021 to SP2022.)

## Setup and Installation (Angular Frontend)

1. Install [Node.js](https://nodejs.org/en/).

2. Clone the repository to a local directory.

3. Run `npm install` at the local repo directory to install dependencies.

> **_NOTE:_** There have been some issues related to installing in certain directories. If an issue arises with installation or running the code, try installing in a different directory.

## Build/Test Software (Angular Frontend)

To build the software, run `ng serve`. Add `--open` at the end to open in the default browser.

> **_NOTE:_** If you are using Windows and run into a "Running scripts is disabled on this system" issue, use `powershell -ExecutionPolicy ByPass ng serve --open`.

## Setup and Installation (Django Backend)

1. Ensure that Python 3.10 is installed.

>> **_NOTE:_** You can verify this by running your python command with a version parameter affixed; "python --version"

2. Clone the repository to a local directory.

3. In a shell or command line, navigate to the "backend" directory and create a virtual python environment inside of it.

> **_EXAMPLES:_** For Powershell users: `py -m venv venv` For MacOS users install virtualenv using `python -m pip install virtualenv` and then use `python -m virtualenv venv`

4. Activate the environment by running the activate script inside of venv/Scripts.

> **_EXAMPLES:_** Example for VSCode with built in Powershell terminal: `& './venv/Scripts/Activate.ps1'`

5. Set your preferred Python interpreter to be the one inside of venv/Scripts.

6. Change to the backend/backend_server directory and within the virtual environment, install dependencies from requirements.txt: (Example: use `python -m pip install -r requirements.txt`

7. Make sure to read tutorials for how to do things in Django!

## Migrate Database (Django Backend)

1. Run `python manage.py makemigrations`

2. Run `python manage.py migrate`

## Build/Test Software (Django Backend)

1. Make sure you are in the virtual environment. You will see a (venv) in your shell if you are in the virtual environment.

> **_NOTE:_** To enter a virtual environment: For Windows from powershell `venv/Scripts/Activate.ps1`. For MacOS from backend directory: `source venv/bin/activate`

2. Go to backend/backend_server directory and use the build software command below.

To build the software, run `python manage.py runserver` in the backend/backend_server directory and navigate to `localhost:8000`.

## Using/Modifying Searching Locations and Information Related to a Location

If needing to use the geocoding API for any reason inside the code (to attain the lat/long of a location), please format input as "city, state" for a single request or multiple "city, state" pairings separated by a "|" for a batch call, as in "city, state|city, state|..."

**_EXAMPLE:_** "tulsa, ok" or "tulsa, ok|denver, co|austin, tx"

If implementing something that pertains to acquiring information for a given location, please add a variable to the constructor of the location object at the bottom of the Map component, that relates to what you are adding, and make sure you save it to its respective location when constructing each location object at the bottom of ngOnInit.

## Contributing

To contribute, make a branch with any changes!