🚇 dc-metro-satire 🚇

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. Contact

About The Project

Funny project that gathers actual DC Metro delay data and if there is no delay on the line it provides a random YouTube video of DC Metro ... inconvenience.

(back to top)

Built With

Front End

• 
• 

Back End

• 
• 

(back to top)

Getting Started

Prerequisites

npm i

• @emotion/styled
• @mui/material

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get a free API Key at WMATA API
2. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

3. Install NPM packages

   npm install

4. Enter your API in src/config.js

   export const METRO_API_KEY = "YOUR API KEY";
   

Roadmap

• Web scrape for DC Metro YouTube videos
• Add Error Alerts
• Multi-language Support
  • Spanish

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)

Contact

(back to top)