Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
iannerney committed Dec 18, 2023
1 parent 0564de2 commit ca48f61
Showing 1 changed file with 24 additions and 23 deletions.
47 changes: 24 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,37 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# Skyway Bridge Status

## Getting Started
## Summary

First, run the development server:
This project is aimed at helping Tampa Bay commuters plan for unexpected closures of the Sunshine Skyway Bridge. This web application collects real-time weather and traffic data from reputable sources, and displays that data on a front-facing website (SkywayBridgeStatus.com).

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
The eventual goal of this project is to create a closure prediction model that is available to the public.

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Project Roadmap

1. Data collection and compiling – ACTIVE, ONGOING SINCE JUNE 2017
2. Near real-time reporting on front facing website (SkywayBridgeStatus.com) – ACTIVE, ONGOING SINCE JUNE 2017
3. Automated status updates to commuters via various channels (email, text, social, etc.) – IN DEVELOPMENT
4. Closure prediction forecasting and reporting – QUEUED

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
## Tech Stack

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
This project uses the following technologies:

## Learn More
- [Next.js](https://nextjs.org/docs) - React framework
- [Ant Design](https://ant.design/docs/react/introduce) - React UI library

To learn more about Next.js, take a look at the following resources:
## Contributers

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
I welcome other contributers to this project! If you'd like to discuss contributing please email me at [email protected], create a issue ticket, or submit a pull request for any documented issue.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## Getting Started

First, you must configure your environment variables. Please send a request to [email protected] to coordinate on any changes.

## Deploy on Vercel
Then, run the development server:

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
```bash
npm run dev
```

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

0 comments on commit ca48f61

Please sign in to comment.