1
Watch
1
Star
0
Fork
1
Issue

Analyzing images from CCTV to determine road status.

codyduong
codyduong
pushedAt 8 months ago

codyduong/mapsy

Contributors Forks Stargazers Issues


Logo

Analyzing images from CCTV to determine road status
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License

About The Project

Mapsy is an interactive web app that analyzes CCTV imagery and weather data to determine realtime road conditions in Lawrence, KS.

Image Demo'ing Mapsy

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

Make sure you have Node.js installed: https://nodejs.org/

Installation

  1. Create a new firebase project in order to get your API keys: https://firebase.google.com/
  2. Generate a Google Maps API Key: https://cloud.google.com/
  3. Clone the repo in terminal:
    git clone https://github.com/codyduong/mapsy.git
  4. In the main folder mapsy, create a .env file and paste your API keys in there. Template below:
    REACT_APP_GOOGLE_MAPS_API_KEY=
    REACT_APP_apiKey=
    REACT_APP_authDomain=
    REACT_APP_projectId=
    REACT_APP_storageBucket=
    REACT_APP_messagingSenderId=
    REACT_APP_appId=
    REACT_APP_measurementId=
  5. Develop or build as needed with
yarn
yarn start
yarn build

(back to top)

Usage

Mapsy makes it easier to view the current status of road conditions, especially during periods of inclement weather. By viewing realtime CCTV images at major intersections, users may determine whether or not the road conditions are safe for travel.

(back to top)

Roadmap

  • Integrate Material UI & Stylized Components
  • Add Google Maps API Integration
  • Add current location zoom to Google Map, fully integrate Searchbar

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)