Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fixed some typos and added some more information
  • Loading branch information
roszar351 committed Dec 10, 2020
1 parent 012def4 commit c8f0950
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Systems Analysis & Design

## Running the application
Whole system is hosted on Amazon Web Services(AWS) as such the Android app will work without needing to run any other software when installed on an adroid device(or running on an emulator), if required changes can be made to run Spring Boot and Database on different machine, this is described in other sections.
Whole system is hosted on Amazon Web Services(AWS) as such the Android app will work without needing to run any other software when installed on an android device(or running on an emulator), if required changes can be made to run Spring Boot and Database on a different machine, this is described in other sections.

## Code Folder - Android Studio GUI
Using Android Studio to code GUI in java for Android devices.
Expand All @@ -12,15 +12,17 @@
- Sample booking:- routeid= 3, quantity= 1, optionalDiscountCode= DFRR (any other routes currently in the database will not allow booking because their date & time has already passed)

## Spring - Spring Boot
Using Java with Spring Boot for creating webservice for business logic, built using maven and hosted on Amazon EBS to which the Android app connects by default.
If needed Spring program can be run on local by running the built jar file found in 'CS4125_Project1_TeamBased\Spring\bookingapp\target' (using 'java -jar' command on 'bookingapp-0.0.1-SNAPSHOT.jar'). After starting up the spring boot application on local machine it can be tested using curl commands e.g.
- To register a user: ' curl localhost:500/registeruser -d name=name -d password=password -d email=email '
- To login: ' curl "localhost:5000/loginuser?name=name&password=password" '
Alternatively it can also be tested using the Android app but if hosting the Spring program on localmachine it requires the host machine and phone to be on the same network and changing the link in the 'RetrofitClientInstance' class found in the Android code.
Using Java with Spring Boot for creating webservice for business logic, built using maven and hosted on Amazon EBS to which the Android app connects by default.
If needed Spring program can be run on local by running the built jar file found in 'CS4125_Project1_TeamBased\Spring\bookingapp\target' (using 'java -jar' command on 'bookingapp-0.0.1-SNAPSHOT.jar').
After starting up the spring boot application on local machine it can be tested using curl commands e.g.
- To register a user: ' curl localhost:5000/registeruser -d name=name -d password=password -d email=email '
- To login: ' curl "localhost:5000/loginuser?name=name&password=password" '

Alternatively it can also be tested using the Android app but if hosting the Spring program on a local machine it requires the host machine and phone to be on the same network and changing the link in the 'RetrofitClientInstance' class found in the Android code, to point to the host machine.

## cs4125_SQL_schema.sql - Database Schema File
MySQL schema file with required tables, this schema has been created on Amazon RDS which the Spring Boot application connects to by default.
If required this schema can be used to host the database on different machine, but will require to change the 'application.properties' file in the Spring boot to point to the machine hosting the database.
If required this schema can be used to host the database on a different machine, but will require to change the 'application.properties' file in the Spring boot to point to the machine hosting the database.

### Authors
- Eoghan Russell
Expand Down

0 comments on commit c8f0950

Please sign in to comment.