This is a RESTful API and web interface (UI using Vue) for a bus travel planner system. The system stores information about routes, stops, and timetable information for the routes. This project aims to give users an easy and efficient way to access bus travel information.
1) AJAY PRADEEP MAHADEVEN - Model, Service Layer and Controllers (Back-end), Code-Review, Report.
2) JIAN LI - UI and API (Front-End) & Report, Code -Review.
3) GABRIEL DOWNER - Tests (Front-end & Back-end), Code -Review, Report.
- Spring FRAMEWORK
- Java 17
- JUnit 5
- Maven
- Git
- Restful API
- .mvn/wrapper
- all_test_frontend - Front-end development folder
- src - Back end development folder
- README.md
- mvnw
- mvnw.cmd
- pom.xml
Terminal Usage or IDE Based For Backend :
- Clone the repository from the school Gitlab server.
- Run
mvn clean compile
to build the project. - Run
mvn test
to run the tests. - Run
mvn spring:boot run
ormvn org.springframework.boot:spring-boot-maven-plugin:run
to access the API. ( try both commands.) - Note : The port allocated for the API is : 8080 .
For Frontend :
- Open all_test_frontend in another project.
- Run
npm install
- Run
npm run dev
- Click on the link generated by the program to access the UI interface.
- Note: Ensure to run the backend before running the front end of the Application.
- Save to file.
- Load to file.
- View All routes.
- View All schedules and stops.
- Get from user DATE (FORMAT : dd-mm-yyyy) only and generate and store DAY automatically.
- Route ID & ScheduleIdentifier : Accepts alphanumeric characters
- Route Name & Stop Name : Accepts only alphabets.
- Clone the repository from the school Gitlab server.
- Create a new branch for your feature or bug fix.
- Write unit tests for your code.
- Could you implement your feature or bug fix?
- Ensure all tests pass.
- Commit your changes and push them to your branch on the Gitlab server.
- Submit a merge request to merge your changes into the main branch.
This project is done part of coursework of CS5031 - Software Engineering Practice of the Computer Science Dept of University of St.Andrews.
This project is licensed under the MIT License.
See the LICENSE
file for more information.