CityRoute Web Application

Built with Vue.js and Django REST Framework.
Explore the docs »

View Live Website · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Vue.js
• Django REST Framework

GETTING STARTED

Getting Started

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

A. Prerequisites

You must have the following before the installation stage below.

• npm

  See here: npmjs.com/get-npm

  npm install npm@latest -g

• Python (Python 3.6)

B. Installation

1. Clone the repo

   git clone https://github.com/CityRoute/Web-App-CityRoute.git

2. cd into the cloned directory

   cd Web-App-CityRoute

3. Install NPM packages

   yarn install

4. Install pip requirements & activate pipenv shell

   pipenv install --dev && pipenv shell

   If you get errors at this step, you may need to install Python 3.6 and point pipenv to this Python version's .exe like so

   pipenv install --python 'C:\YourPythonDirectory\python.exe' --dev && pipenv shell

C. Running the application

1. Serve the frontend

   yarn serve

2. Serve the backend. Note: You must be in pipenv shell at this point.

   python manage.py runserver

3. Access the frontend application from http://localhost:8080/
4. Access the backend api from http://localhost:8000/

Now the frontend and backend will automatically refresh when changes are saved to their files.

Usage & Features

Journey Planner

Plan your journey and get your journey time estimation using our Machine Learning models. Share the journey with your friends using the buttons below or add it to your favourites to save for later!

Stop Finder

Find the stop you need and get the times buses will be arriving to it. Get directions to your stop and save it to your favourties!

Favourites

View your previously saved favourite journey, stops & routes and click on them to get directions!

Review your Route!

Leave a review for a route you recently travelled on so other passengers know what to expect!

About Us

Take a look at our about us page to see who we are!

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

• Brian Manning (manningb) brian.manning@ucdconnect.ie
• Stephanie O'Neill
• Faye Arejola
• Conor Kiy

Project Link: https://github.com/CityRoute/Web-App-CityRoute