/Shelter-Gaze

map of shelters in NYC hosted on AWS infrastructure.

Primary LanguageJavaScript

Maintainability Test Coverage

Shelter Gaze

You can find the deployed project at shelterhub.com.

Contributors

Ebony James Jan Pramod Rayvon


Project Overview

1️⃣ Trello Board

2️⃣ Product Canvas

ShelterHub is a comprehensive platform aimed at connecting migrants in NYC with safe shelters. The platform includes features such as real-time geolocation, detailed shelter information, and multilingual support, providing a user-friendly experience for those seeking shelter.

Key Features

  • Real-time geolocation to find nearby shelters.
  • Detailed information and contact details for each shelter.
  • Multilingual support for accessibility.
  • Automatic translation into the user's native language.
  • Search and filtering options for personalized results.

Tech Stack

Frontend

1️⃣ React React

2️⃣ React-DOM React-DOM

3️⃣ React-Map-GL npm

4️⃣ Mapbox-GL npm

5️⃣ @types/Mapbox/GL npm

6️⃣ Maplibre-GL npm

7️⃣ @Radix-UI/Themes npm

8️⃣ Vite Vite

Backend

2️⃣ AWS Lambda

  • Serverless computing for scalable backend.

3️⃣ Amazon API Gateway

  • Creating, publishing, and securing APIs at any scale.

4️⃣ DynamoDB

  • Fully managed NoSQL database service.

5️⃣ Amazon S3

  • Scalable object storage for hosting React app.

APIs

1️⃣ Mapbox

  • For detailed and interactive mapping.

2️⃣ Google Maps Directions API

  • Providing walking or driving directions to shelters.

3️⃣ Amazon Translate

  • Automatic translation for multilingual support.

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

  • REACT_APP_SERVER_URL - for your local development server.

Testing

1️⃣ Jest Jest

  • Jest is a JavaScript Testing Framework with a focus on simplicity.

Installation Instructions

  • Clone this repo
  • Run yarn install to install all required dependencies
  • Run yarn start to start the local server

Other Scripts

  • start - "react-scripts start", starts the production server after a build is created.
  • build - "react-scripts build", creates a build of the application.
  • test - "react-scripts test", runs tests in tests directory.
  • eject - "react-scripts eject", copy the configuration files and dependencies into the project.
  • coverage - "CI=true yarn test --coverage --

watchAll=false || true", refers to how much of your app code is covered by unit tests.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers or request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.