gcivil-nyu-org / inet-monday-spring2023-team-5 Goto Github PK

Home Page: https://bamnyc.pythonanywhere.com

Python 9.45% SCSS 22.74% HTML 14.62% CSS 8.51% JavaScript 44.68%

inet-monday-spring2023-team-5's Introduction

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

inet-monday-spring2023-team-5's People

Contributors

Stargazers

Watchers

Forkers

moringspeaker sunorous alfarouksaleh stephaniehou vchrombie

inet-monday-spring2023-team-5's Issues

Zenhub cards

Forgot username or password

Register/Login/Logout Accounts

The user should be able to

register an account
login to his account
logout of the account
view his profile

User Registration

The user should be able to register using a form if they don't have an account

form should contain the details like first name, last name, email, password
should also have password confirmation
check if the password matches
check if there is an account existing with that email
create a new account after submitting the button
redirect to user profile

View information about neighborhood

As a user, I want to see the neighborhood’s crime level, noise level and more information about the neighborhood.

Business Login (Backend)

As a business user, I want to be able to login to my business account.

Add/View/Delete Business

The user should be able to

add a business
view the business

User Logout

The user after login should be able to logout by clicking the button.

should validate if the user is logged in
user should be logged out after clicking the logout button

Context diagram

Fixing Deployment Issues.

View a business

The user after adding a business should be able to view the business details.

should validate if the user is logged in
show the business details on the view business page
should be able to add a new business
should be able to edit the business

Create an account using email and password

User Login (Backend)

As a user, I want to be able to login to my account using the correct email and password.

Manage Forums

Post reviews of a neighborhood

As a user, I want to be able to leave a review for a neighborhood, including a written description of my experiences living there or visiting, so that others can benefit from my insights.

Manage Neighborhoods

Users can choose a specific NYC neighborhood, view information of the neighborhood, see neighborhood reviews from other users, rate the neighborhood, and access the various neighborhood pages (forum, marketplace, services Page).

Post on forums of a neighborhood

As a user, I want to be able to view the latest news and events related to a neighborhood on the forum, so that I can stay up to date on what's happening in the area.

Django project in team github

Search and discovery

Forgot username or password

Update account profile

Search a neighborhood

As a user, I want to be able to search for a neighborhood by entering a specific location or zip code and opening its page so that I can know information about this neighborhood.

Update/Delete User Profile

Manage Users

Login and Logout

Create an account using email and password

User Login

The user should be able to login to his profile.

login should have a form with email and password fields
should check if the user has an account
fetch his profile and stores the session
redirect to his profile
should be able to logout
should be able to register a business or view a business

View Businesses in the Services Page.

Select composter or acceptor?

Identify User Personas

Rate a neighborhood

As a user, I want to be able to rate a certain neighborhood on various factors such as safety, community amenities and street-level greenery etc.

User Profile

The user after login should be able to view their profile.

should validate if the user is logged in
the profile should show the user details like first name, last name, and the list of their businesses if they have any
each business should show the name, address, phone number and email contact

Front_end: Webpage can't spread out my whole screen

As you can see, the web page on my computer has a very visible border. My screen's solution is : 3440*1440

Account registration and managment

Add a business

The user after login should be able to add a business using the add business form.

should validate if the user is logged in
form should contain the business fields
create a business with the data from the fields and the user as owner
redirect to viewing the business page