Fabulous Restaurants

A restaurant review app to share fabulous restaurants on your list
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Fabulous Restaurants is a restaurant review sharing app. It provides a platform for users to share their reviews, comments, location, and contacts. It is a cross-platform application that supports web and mobile.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

1. Install Node.js which includes Node Package Manager
2. Install the Angular CLI globally:

   npm i -g @angular/[email protected]

Installation

Web

1. Clone the repo

   git clone https://github.com/junseo-yang/fabulous-restaurant.git

2. Change directory

   cd fabulous-restaurants

3. Install NPM packages

   npm install

4. Run the application:

   ng serve

Mobile

1. Install ADB
2. Connect an Android device
3. Install apk file

   adb install fabulous-restaurant.apk

4. Run the application on the Android device

(back to top)

Usage

Web

Restaurants

1. Add/Edit/Delete your favourite restaurants
   • 
2. List/View your favourite restaurants
   • 

Reviews

1. Add/Edit/Delete your reviews about favourite restaurants
   • 
2. List/View your reviews about favourite restaurants
   • 

Mobile

Restaurants

1. Add/Edit/Delete your favourite restaurants
   • 
2. List/View your favourite restaurants
   • 

Reviews

1. Add/Edit/Delete your favourite restaurants
   • 
2. List/View your favourite restaurants
   • 

(back to top)

Roadmap

• Implement CRUD for Restaurants and Reviews
• Implement Login
• Implement Admin user management
• Implement Different nav for Admin
• Implement Geolocation (Here map) - Leverage Android Native GPS Feature
• Import AuthGuard
• Prohibit duplicate username
• Initialize admin with admin and password
• Foreign key constraints - can't delete restaurant if it has a related review.
• Return to the url when you logout and login
• Fix password change blank

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Junseo Yang

• 💼 LinkedIn: https://linkedin.com/in/junseo-yang
• 🎒 Website: https://junseo-yang.github.io
• 📫 [email protected]

Project Link: https://github.com/junseo-yang/fabulous-restaurant

(back to top)