storms.watch

We in storm mode, baby.

About The Project

storms.watch is the premier location to watch hurricane streams and stay up to date on all the latest tropical storms. Storm streams are hand-picked while we are in storm mode (an active storm is in the gulf) for your viewing, along with a feed from /r/TropicalWeather, and tropical weather Twitter.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• node
• yarn

Installation

1. Clone the repo

   $ git clone https://github.com/angelle-sw/storms.watch.git

2. Install packages

   $ yarn install

3. Enter environment variables in .env

   MONGO_DB_URI=<mongo-db-uri>
   ADMIN_PASSPHRASE=<admin-passphrase>

4. Set an item in the cookies of the site

   document.cookie="adminPassphrase=<admin-passphrase>"

5. Run a local development environment

   $ yarn dev

(back to top)

API Spec

Type	Endpoint	Body	Headers	Response
POST	/api/postVideoSources	{id: string; status: boolean; title: string; url: string; }[]	{ admin-passphrase: string; }	{ id: string; status: boolean; title: string; url: string; }[]
POST	/api/toggleStormModeStatus	--	{ admin-passphrase: string; }	boolean
GET	/api/getStormModeStatus	--	{ admin-passphrase: string; }	boolean
GET	/api/getVideoSources	--	--	{ id: string; status: boolean; title: string; url: string; }[]
GET	/api/getAdminStatus	--	{ admin-passphrase: string; }	boolean

(back to top)

Debugging

Use a supported url query param to override the database values

Key	Value	Description
stormModeStatus	boolean	Forces the app in or out of storm mode

(back to top)

Roadmap

• Support multiple concurrent storms
• Toggleable social feed drawer

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)

Acknowledgments

• mr. min
• charlie
• f off
• pigs
• cinnamon toast crunch
• great american cookie company

(back to top)