Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated Readme #30

Merged
merged 2 commits into from
Oct 24, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
102 changes: 88 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,94 @@
# Flight-Management-System
This consist back end of the Flight Management System using Spring Boot and Angular 9 based UI.
# Flight Reservation System
<p style="text-align: center;"><img src="./FMS-Level-3-Angular/src/assets/airplane-wing-sky.jpg" alt="airplane drawing"></p>

## Development server
Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
## 🌐 Description
The Flight Reservation System is a Java-based solution that allows users to quickly book flights and manage booking information, updates, and cancellations easily. It consolidates data from different airline carriers and thus provides all the necessary details and rates in real-time. In addition, administrators of flight data can also quickly view, create, and update any information about flights, bookings, routes, and schedules.

## Code scaffolding
Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

## Build
Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.
## 💻 Technologies
#### Backend Technologies:
1. Java 8
1. Spring Boot
1. JPA
1. REST API
1. JUnit Testing
#### Frontend Technologies
1. HTML
1. CSS
1. Bootstrap
1. Typescript
1. Angular
#### Database Management
1. Oracle
1. H2 Database

## Running unit tests
Run ng test to execute the unit tests via Karma.
## ℹ️ Background
How many times have you started dreaming of a new trip, but then the hassle of planning, finding the right flight, and booking it was so frustrating as to make you wonder if the trip was worth it?! Those frustrations end today with the Flight Reservation System's one-stop shop for your tickets!

## Running end-to-end tests
Run ng e2e to execute the end-to-end tests via Protractor.
## ✈️ Features
The Flight Reservation System can be accessed by two categories of users: Customers and Administrators.
#### Features for Customeres
1. Customers can create a new account in order to log in.
1. Customers can search available flights.
1. Customers can make a booking, view current bookings, and modify and cancel a booking, if needed.
1. Customers can see airport details for the airports associated with their flight(s).
#### Features for Administrators
1. Administrators can view all details for flights, schedules, and routes.
1. Administrators can add, modify, and cancel flights, schedules, and routes.


## 📷 Screenshots
tbd

## 📘 Backlog
The Flight Reservation System does not currently include the following features:
1. Generating seating plans
1. Generating boarding passes
1. Integrating with third-party applications, such as email and SMS
1. Processing payments


## 🤝 Contributors
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add your name as well in your next PR here.

@ancasimon

Will be great to see your name also here on the contributor list.

[Sanchit Singhal](https://github.com/sanchit2107)

[Shaivi Sinha](https://github.com/ShaiviSinha)

[Shivani Luthra](https://github.com/Shivaniluthra)

[Vaibhav229](https://github.com/ShaiviSinha)

## For Developers
#### Access the App
1. Install Angular CLI if not already installed in your system.
1. Clone this project.
1. Run `npm install` in the `cmd` line in the directory of the project.
1. Then, run `ng serve` command.

#### Want to Contribute?
1. Fork this repo.
1. Check out the Issues tab and comment on the issue you would like to work on.
1. Clone the forked repo.
1. Test your changes thoroughly. Add meaningful and accurate commit messages. Include inline comments for complex logic and any external library. Update Readme if necessary.
1. Create a Pull Request. Check out this tutorial for details: https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github.

## Technical Details
#### How to Run It
1. Run `ng serve` for a dev server.
1. Navigate to http://localhost:4200/.
1. The app will automatically reload if you change any of the source files.

#### Code Scaffolding
1. Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.

#### Build
1. Run `ng build` to build the project. The build artifacts will be stored in the `dist/ directory`. Use the `--prod` flag for a production build.

#### Running Unit Tests
1. Run `ng test` to execute the unit tests via Karma.

#### Running End-to-End Tests
1. Run `ng e2e` to execute the end-to-end tests via Protractor.

#### Further Help
To get more help on the Angular CLI use `ng help` or go check out the Angular CLI README.

## Further help
To get more help on the Angular CLI use ng help or go check out the Angular CLI README.