Y-Eat is clone inspired by Yelp. Y-Eat can be used to create and showcase one's businesses, and allow other users (customers/visitors) to rate and review their businesses.
- On the splash page, 3 main components can be found.
- The NavBar where a user can log in or sign up
- The body that welcomes the user to Y-Eat, and a button to see all the businesses listed on the app
- The footer that includes information about this project, and links to get to know the devs
- On this page, a user can see businesses, and also search / filter through the businesses to find a specific one they are looking for
- A user can also click on the different business cards to be redirected to the business' page
- A page to see more details about the business
- Users can see reviews about the specific business currently being viewed
- A button to create / edit a review is also available on this page
- Create a new review or edit your existing review for the business
- Creating a business is split into 3 forms
- The main info/details of the business
- Categories are available for the user to choose from for their business
- Amenities are also available for the user to choose from to describe further about their business
- Clone the repository
- cd into the project directory and run
pipenv install - Create a
.envfile in the root of the project and add the following variables
SECRET_KEY=<<SECRET_KEY>>
DATABASE_URL=sqlite:///dev.db
- Create another
.envfile in the root of the react-app directory and add the following variables
REACT_APP_BASE_URL=http://localhost:5000
- You will need two terminals to run this locally.
- The first terminal will be used for the backend server, run
pipenv shell - Then run the following commands in the terminal
flask db upgrade
flask seed all
- The second terminal will be used for the frontend server. cd into the react-app directory and run the following commands
npm install
- Finally run the following command in the second terminal while still in the react-app directory
npm start