opeyimika-sudo / fyuur

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.

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.

This project involved building out 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

Fyyur is a platform that artists and musical venues can use to find each other, and discover new music shows. This site 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.

Demo

Tech Stack

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

Main Files: Project Structure

├── README.md
├── app.py *** the main driver of the app. Includes your SQLAlchemy models.
                  "python app.py" to run after installing dependencies
├── config.py *** Database URLs, CSRF generation, etc
├── error.log
├── forms.py *** Your forms
├── 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 the MODELS section of app.py.
• Controllers are also 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

Highlight folders:

• templates/pages -- Defines the pages that are rendered to the site.
• templates/layouts -- Defines the layout that a page can be contained in to define footer and header code for a given page.
• templates/forms -- Defines the forms used to create new artists, shows, and venues.
• app.py -- Defines routes that match the user’s URL, and controllers which handle data and renders views to the user.
• Models in app.py -- Defines the data models that set up the database tables.
• config.py -- Stores configuration variables and instructions, separate from the main application code. This is where you will need to connect to the database.

Development Setup

First, install Flask if you haven't already.

$ cd ~
$ sudo pip3 install Flask

To start and run the local development server,

1. Initialize and activate a virtualenv:

$ cd YOUR_PROJECT_DIRECTORY_PATH/
$ virtualenv --no-site-packages env
$ source env/bin/activate

2. Install the dependencies:

$ pip install -r requirements.txt

3. Run the development server:

$ export FLASK_APP=myapp
$ export FLASK_ENV=development # enables debug mode
$ python3 app.py

4. Navigate to Home page http://localhost:5000

Acknowledgment

The Udacity Team