Penn Labs Backend Challenge

Documentation

Fill out this section as you complete the challenge!

Installation

1. Click the green "use this template" button to make your own copy of this repository, and clone it. Make sure to create a private repository.
2. Change directory into the cloned repository.
3. Install pipx
   • brew install pipx (macOS)
   • See instructions here https://github.com/pypa/pipx for other operating systems
4. Install poetry
   • pipx install poetry
5. Install packages using poetry install.

File Structure

• app.py: Main file. Has configuration and setup at the top. Add your URL routes to this file!
• models.py: Model definitions for SQLAlchemy database models. Check out documentation on declaring models as well as the SQLAlchemy quickstart for guidance
• bootstrap.py: Code for creating and populating your local database. You will be adding code in this file to load the provided clubs.json file into a database.

Developing

0. Determine how to model the data contained within clubs.json and then complete bootstrap.py
1. Activate the Poetry shell with poetry shell.
2. Run python3 bootstrap.py to create the database and populate it.
3. Use flask run to run the project.
4. Follow the instructions here.
5. Document your work in this README.md file.

Submitting

Follow the instructions on the Technical Challenge page for submission.

Installing Additional Packages

Use any tools you think are relevant to the challenge! To install additional packages run poetry add <package_name> within the directory. Make sure to document your additions.