Skip to content

Latest commit

 

History

History
70 lines (58 loc) · 2.65 KB

README.md

File metadata and controls

70 lines (58 loc) · 2.65 KB
Raw

<Yell>

Yell is our attempt at creating a Yelp Clone which allows users to create a business page containing information about their business as well as the ability to review other's businesses.

Screenshots

Login Page

Login

Signup Page

Signup

Business Page

BusinessPage

Features

  • Businesses

    • Create new business
    • Edit existing business
    • Delete existing business
    • Show details of a specific business

  • Hours

    • Create new open and closing hours for a business
    • Edit existing business hours
    • Show hours of a specific business

  • Categories

    • Link a business to a category
    • Unlink a business to a category
    • Show only businesses belonging to a specific category

  • Google Map

    • Show a map with a pin of current business based on latitude and longitude

  • Search

    • Search for all currently open businesses
    • Search for businesses by category

Technologies Used

  • Python
  • Flask
  • SQLAlchemy
  • Sqlite3
  • React
  • Redux
  • Html5
  • Css
  • Git
  • Javascript

Setting up the application

  • Click the green dropdown menu called "<> Code" and copy the url "https://github.com/henrytamm/Yell.git"
  • Open up a terminal and navigate to the folder you would like the files to be in
  • Type git clone then hit space and paste the url "git clone https://github.com/henrytamm/Yell.git" into your terminal and press enter
  • Make a .env file in the root folder '/yell/.env' and copy paste the following code or copy the .env.example file: 
        SECRET_KEY=lkasjdf09ajsdkfljalsiorj12n3490re9485309irefvn,u90818734902139489230
    DATABASE_URL=sqlite:///dev.db
    SCHEMA=flask_schema
  • Navigate to frontend folder called '/yell/react-app' through your terminal and type "npm install" then press enter
  • Navigate to root folder called '/yell' through your terminal and type "python --version" then press enter to check your current version of python
  • Run the following command replacing 3.9.4 with your version number of python: pipenv install --python "$PYENV_ROOT/versions/3.9.4/bin/python"
  • Then run this command: pipenv install click gunicorn itsdangerous python-dotenv six Flask Flask-Cors Flask-SQLAlchemy Flask-WTF Jinja2 MarkupSafe SQLAlchemy Werkzeug WTForms Flask-Migrate Flask-Login alembic python-dateutil python-editor greenlet Mako pycodestyle pylint psycopg2-binary email_validator
  • Navigate to root folder through your terminal and type "pipenv shell" then press enter, then "flask run" and your backend should now be started
  • Open a separate terminal and navigate to your frontend folder then type "npm start" to start your frontend