Commute Status Web App

Commute Status a simple Web and Android app to quickly see the status of your commute.

Check it out! · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Commute Status is a simple Web and Android app to quickly and easily see the status of your commute.

Check out the Android App.

Check out the Web App.

Built With

• Java
• Spring Boot
• National Rail Darwin API
• Auth0
• Postgres

Getting Started

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

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Maven

mvn install

Environment Variables

• AUTH0_CLIENT_ID
• AUTH0_CLIENT_SECRET
• AUTH0_CLIENT_SECRET
• AUTH0_REFRESH_SECRET
• AUTH0_DOMAIN
• NATIONAL_RAIL_ACCESS_TOKEN
• POSTGRES_HOST
• POSTGRES_PORT
• POSTGRES_DATABASE
• POSTGRES_USERNAME
• POSTGRES_PASSWORD

Installation

1. Clone the commutestatus-api

git clone https://github.com/BenSuskins/commutestatus-api.git

2. Install Maven dependencies

mvn install

2. Run application

mvn spring-boot:run

Roadmap

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

Contributing

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

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ben Suskins - @BenSuskins - suskinsdevelopment@gmail.com

Project Link: https://github.com/BenSuskins/commutestatus-api

Acknowledgements