BAM

From Noisy to Nice - Let BAM Help You Find Your Perfect Neighborhood.

Branch	Build	Coverage	Link
main			bam-nyc
develop			bam-nyc-dev

BAM (Big Apple Move) is a web-based application that provides comprehensive information and guidance for individuals looking to live in or move to New York City. It offers a personalized experience with features such as centralized location data, interactive forums, and user profiles. BAM offers an interactive map of NYC neighborhoods, complete with information on noise levels, crime statistics, safety, transportation, and more. Whether you're a first-time visitor, student, young professional, family, or retiree, BAM is your ultimate guide to finding the perfect home in the city that never sleeps.

Setup

Installation

We use poetry to setup, manage and install dependencies for the project.

$ git clone https://github.com/gcivil-nyu-org/INET-Monday-Spring2023-Team-5/
$ cd INET-Monday-Spring2023-Team-5
$ poetry install
$ poetry shell

Setup env variables

(.venv) $ export DJANGO_SECRET_KEY="$(python -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())')"
(.venv) $ export MAPBOX_API_KEY="<your-mapbox-api-key>"

Run the project locally

(.venv) $ python manage.py makemigrations
(.venv) $ python manage.py migrate
(.venv) $ python manage.py createsuperuser # admin:admin
(.venv) $ python manage.py loaddata fixtures/neighborhood.json
(.venv) $ python manage.py runserver

Run the tests

(.venv) $ coverage run --source='.' manage.py test
(.venv) $ coverage report

Other

• Deployed using AWS Elastic Beanstalk
• Code formatting using black
• Code linting using flake8
• Code coverage using Coveralls.io
• CI/CD using Travis CI
• Maps integration with Mapbox.

---

Team 5

1. Elfarouk Saleh
2. Chenyu Gu
3. Weiye Sun
4. Stephanie Hou
5. Venu Vardhan Reddy Tekula