README.md

Author: rumeshmadhusanka

README.md

@@ -1,40 +1,21 @@
-# Software Engineering Project Back-end API
+# Airline Reservation System REST API
+![logo](db%20api.jpg)
 
-###Deployment 
-https://software-engi.herokuapp.com/
+## Prerequisites
+-pm2 ```$ npm i pm2 -g```
 
-System Architecture Document
-https://docs.google.com/document/d/1br3VXRLCZ9pewrxHVNTTnKmoyK74qNNXEE7DNkahrDU/edit
-![alt text](public/images/DB%20schema%20design.png)
-_GET customer/:id_
+## Install
+```
+$ npm install 
+```
 
-{
-    "success": true,
-    "error_code": "",
-    "message": "Affected Rows: 1",
-    "data": [
-        {
-            "id": 1,
-            "first_name": "Kamal",
-            "last_name": "Fernando",
-            "email": "kamal@gmail.com",
-            "contact_no": "0786564786"
-        }
-    ],
-    "token": ""
-}
+## Quick Start
 
-_POST customer_
+-Run the project- ```$ npm start```
 
-{
-	"first_name":"Amal",
-	"last_name":"Rathnayake",
-	"email":"amal@gmail.com",
-	"contact_no":"0786567654",
-	"password":"uvh dvfvrtgbtgbhtbb hdbhb f"
-}
-
-_PUT customer/:id_
-
-_DELETE customer/:id_
+## Authors
 
+-[Rumesh Madhusanka](https://github.com/rumeshmadhusanka)
+-[Kushan Chamindu](https://github.com/KushanChamindu)
+-[Shashimal Senarath](https://github.com/shashimalcse)
+-[Jayampathi Adhikari](https://github.com/jayampathiadhikari)