diff --git a/README.md b/README.md index 7d50f2c..de04e86 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,12 @@ # Zomato -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 6.1.3. +The aim of the project is to create Zomato kind of application using Angular using Zomato’s API as backend and the frontend application contains all the features mentioned below. -## Development server +Features of the Application +1) Home page - On Home page landing first detects the user location according to location (latitude and longitude) and shows the restaurants in card list format with image and brief details. There is one search bar. Where user can search the restaurants with location. After clicking on particular restaurant detailed page opens. -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. +2) Details View - This view contains all information like images, menu, reviews etc and other information related to restaurant. -## Code scaffolding +3) Error Views - If API is failed or restaurant not found that time it shows error page. -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. - -## Running unit tests - -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). - -## Running end-to-end tests - -Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/). - -## Further help - -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md). -# zomato-source-code +4) Additional Feature - When searching in the search box, it shows top 3 restaurants of that city and also shows the most popular cuisines.