Giter Club home page Giter Club logo

thenameisajay / route-mapping-application Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 259 KB

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. The aim of this project is to provide users with an easy and efficient way to access bus travel information.

License: MIT License

HTML 0.58% Vue 19.21% JavaScript 0.60% Java 79.60%
intellij junit5 maven mvc-architecture restful-api test-driven-development vue

route-mapping-application's Introduction

CS5031 - Software Engineering Practices - P2

NAME

ROUTE MAPPING SYSTEM USING SPRING FRAMEWORK AND RESTFUL API

DESCRIPTION

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.

Authors and acknowledgement

Team Members :

        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.

Technologies Used

  • Spring FRAMEWORK
  • Java 17
  • JUnit 5
  • Maven
  • Git
  • Restful API

FILE STRUCTURE :

  1. .mvn/wrapper
  2. all_test_frontend - Front-end development folder
  3. src - Back end development folder
  4. README.md
  5. mvnw
  6. mvnw.cmd
  7. pom.xml

SETUP AND INSTALLATION

Terminal Usage or IDE Based For Backend :

  1. Clone the repository from the school Gitlab server.
  2. Run mvn clean compile to build the project.
  3. Run mvn test to run the tests.
  4. Run mvn spring:boot run or mvn org.springframework.boot:spring-boot-maven-plugin:run to access the API. ( try both commands.)
  5. Note : The port allocated for the API is : 8080 .

For Frontend :

  1. Open all_test_frontend in another project.
  2. Run npm install
  3. Run npm run dev
  4. Click on the link generated by the program to access the UI interface.
  5. Note: Ensure to run the backend before running the front end of the Application.


EXTRA FUNCTIONALITIES

  1. Save to file.
  2. Load to file.
  3. View All routes.
  4. View All schedules and stops.
  5. Get from user DATE (FORMAT : dd-mm-yyyy) only and generate and store DAY automatically.
  6. Route ID & ScheduleIdentifier : Accepts alphanumeric characters
  7. Route Name & Stop Name : Accepts only alphabets.

NO OF TESTS WRITTEN: 81


CONTRIBUTION GUIDELINES :

  • 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.

License

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.

route-mapping-application's People

Contributors

thenameisajay avatar gabriellucien avatar dependabot[bot] avatar lijianwei2465 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.