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.
Tech stack includes the following:
- virtualenv as a tool to create isolated Python environments
- SQLAlchemy ORM ORM library of choice
- PostgreSQL Database of choice
- Python3 and Flask Server language and server framework
- Flask-Migrate Creating and running schema migrations
You can download and install the dependencies mentioned above using
pip
as:
pip install virtualenv
pip install SQLAlchemy
pip install postgres
pip install Flask
pip install Flask-Migrate
You must have the HTML, CSS, and Javascript with Bootstrap 3 for our website's frontend. Bootstrap can only be installed by Node Package Manager (NPM). Therefore, if not already, download and install the Node.js. Windows users must run the executable as an Administrator, and restart the computer after installation. After successfully installing the Node, verify the installation as shown below.
node -v
npm -v
Install Bootstrap 3 for the website's frontend:
npm init -y
npm install bootstrap@3
├── README.md
├── app.py *** the main driver of the app. Includes SQLAlchemy models.
"python app.py" to run after installing dependences
├── config.py *** Database URLs, CSRF generation, etc
├── error.log
├── forms.py *** Forms
├── requirements.txt *** The dependencies to install with "pip3 install -r requirements.txt"
├── static
│ ├── css
│ ├── font
│ ├── ico
│ ├── img
│ └── js
└── templates
├── errors
├── forms
├── layouts
└── pages
Overall:
- Models are located in
models.py
. - Controllers are located in
app.py
. - The web frontend is located in
templates/
, which builds static assets deployed to the web server atstatic/
. - Web forms for creating data are located in
form.py
Highlight folders:
templates/pages
-- Defines the pages that are rendered to the site. These templates render views based on data passed into the template’s view, in the controllers defined inapp.py
. These pages successfully represent the data to the user, and are already defined for you.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. This is the main file you will be working on to connect to and manipulate the database and render views with data to the user, based on the URL.models.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.
The goal of this project was to implement the data modeling for a full stack application.
- Provided with HTML, CSS and JS elements, I implemented the Python back-end as well as some JavaScript and HTML portions.
- This project makes use of SQLAlchemy to connect with and manipulate a Postgresql database
- Initialize and activate a virtualenv using:
python -m virtualenv env
source env/bin/activate
Note - In Windows, the
env
does not have abin
directory. Therefore, you'd use the analogous command shown below:
source env/Scripts/activate
- Install the dependencies:
pip install -r requirements.txt
- Run the development server:
export FLASK_APP=app.py
export FLASK_ENV=development # enables debug mode
flask run
- Verify on the Browser
Navigate to project homepage http://127.0.0.1:5000/ or http://localhost:5000
- The Udacity Team for providing the starter code which included the CSS, as well as the majority of JavaScript and HTML code