Restro

Table of Contents

1. Introduction
2. Project Features
3. Objectives of the project
4. Technologies
5. Installation
6. Contributions
7. Author
8. Bugs & Feature Request

Restro

Brief description of application

You’re probably already aware that it can be hard to find the right restaurant and some times when you do and visit it, you find that it is not what you expected.You've been searching for a new restaurant to try, but it's hard to tell which ones are good. What if you could just go online and find them instantly?

To solve this problem, I have decided to create a restaurant finder app that helps people who are new to the area and looking for a good place to eat. Through sharing the restaurants details and also the food that they serve. You can judged how good the restaurant is from the reviews that users share.

Project Features

• Home Page - First page user sees when they visit the site which contains all the restaurants
• Login Page - Logs in user to use the application
• Sign Up page - Registers user to use the application
• Restaurant Page - Displayes a single restaurant, its dishes and reviews.

Objective of the project

• Logs in user to the posts page when there credentials are verified
• Signs up user to enable the use the application
• User can post questions on the posts page
• User can comment on a particular post
• User are logged out when they click the log out button

Technologies Used

• React - it was used to design, structure and add content to the web pages
• Ruby on rails - it was used to create the backend part of the application
• Netlify - it was used for deployment

Installation

• Fork the repo and clone it on your machine using the following command in your terminal:
  git clone [<path to repo>](https://github.com/Murage-Ivy/restro)
• Navgiate to the cloned repo
  cd /restro
• Open the cloned repo on your visual studio by using this command:
  code .
• Install dependecies
  npm install
• Install react-router-dom
  npm i react-router-dom
• Run server
  npm run server
• Start Project
  npm start

Contributions

• Fork this repository.

• Create a branch:
  git checkout -b <branch_name>.

• Make your changes and commit them:
  git commit -m '<commit_message>

• Push to the original branch:
  git push origin <project_name>/<location>

• Create the pull request.

  Alternatively see the GitHub documentation on creating a pull request creating a pull request.

Link To Backend Repo

Backend Repo

Bugs & Fixes / Feature request

In case you find a bug, kindly open an issue here. Include your query and your expected results.

Date of current version

7/12/2022

Author

Ivy Wambui Murage

License

MIT Copyright (c) 2022 Ivy Murage

Acknowledgments

• Moringa School