README.md

Fyyur

Introduction

Fyyur is a musical venue and artist booking site that facilitates the discovery and bookings of shows between local performing artists and venues. This site lets you list new artists and venues, discover them, and list shows with artists as a venue owner.

I built the data models to power the API endpoints for the Fyyur site by connecting to a PostgreSQL database for storing, querying, and creating information about artists and venues on Fyyur.

Overview

This app started out with the front end and was missing real data, a connection with SQL and adjustments on the fornt end! It was missing models and model interactions to be able to store retrieve, and update data from a database. Now it is a fully functioning site that is capable of doing the following, using a PostgreSQL database:

• creating new venues, artists, and creating new shows.
• searching for venues and artists.
• learning more about a specific artist or venue.

Images of Site

Tech Stack

Our tech stack includes:

• SQLAlchemy ORM to be our ORM library of choice
• PostgreSQL as our database of choice
• Python3 and Flask as our server language and server framework
• Flask-Migrate for creating and running schema migrations
• HTML, CSS, and Javascript with Bootstrap 3 for our website's frontend

Main Files: Project Structure

├── README.md
├── app.py *** the main driver of the app.
                  "python3 app.py" to run after installing dependences
├── config.py *** Database URLs, CSRF generation, etc
├── error.log
├── forms.py
├── models.py  
├── requirements.txt *** The dependencies we need to install with "pip3 install -r requirements.txt"
├── static
│   ├── css
│   ├── font
│   ├── ico
│   ├── img
│   └── js
└── templates
    ├── errors
    ├── forms
    ├── layouts
    └── pages

Overall:

• Models are located in app.py.
• Controllers are located in app.py.
• The web frontend is located in templates/, which builds static assets deployed to the web server at static/.
• Web forms for creating data are located in form.py

Getting Started

• Clone this repository.
• Clone this repo: git clone git@github.com:clc80/Fyyur.git
• Change to the repo directory: cd Fyyur
• create envirment: poetry shell
• Install dependencies with poetry: poetry install
• Connect your local database
  • in app.py app.config['SQLALCHEMY_DATABASE_URI'] = '<your database>'
  • in config.py SQLALCHEMY_DATABASE_URI = '<your database>'
• Run the development server:

  $ export FLASK_APP=myapp
  $ export FLASK_ENV=development # enables debug mode
  

OR $ python3 app.py

* Navigate to Home page [http://localhost:5000](http://localhost:5000)