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.
We want Fyyur to be the next new platform that artists and musical venues can use to find each other, and discover new music shows. Let's make that happen!
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
├── README.md
├── app.py *** the main driver of the app.
├── config.py *** Database URLs, CSRF generation, etc
├── error.log
├── extensions.py *** Contains all tools such as CSRF, DB and Migrate
├── forms.py *** FrontEnd forms
├── models.py *** SQLAlchemy models
├── requirements.txt *** The dependencies we need to install with "pip3 install -r requirements.txt"
├── migrations
└── ...
├── static
│ ├── css
│ ├── font
│ ├── ico
│ ├── img
│ └── js
└── templates
├── errors
├── forms
├── layouts
└── pages
Overall:
- Models are located in
models.py
. - Controllers are also 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.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.py
-- Defines the data models that set up the database tables.config.py
-- Stores configuration variables and instructions, separate from the main application code.
To start and run the local development server,
- Initialize and activate a virtualenv:
$ cd YOUR_PROJECT_DIRECTORY_PATH/
$ virtualenv --no-site-packages env
$ source env/bin/activate
- Install the dependencies:
$ pip install -r requirements.txt
- Run the development server:
$ export FLASK_APP=myapp
$ export FLASK_ENV=development # enables debug mode
$ python3 app.py
- Navigate to Home page http://localhost:5000