ada-c19 / solar-system-api

Solar System API

Goal

• Improve our understand of Flask & SQL Alchemy with repetition
• Discuss and explain Flask code together in pair or group programming
• Improve skill at working with others.
  • Software teams thrive on collaboration, so working side-by-side with someone while coding is vital!

In this activity, we will build a Solar System API. This API will store information about different planets.

We will focus on creating RESTful endpoints for CRUD operations.

Tips

• Don't forget to work in a virtual environment
• Put endpoints in app/routes.py
• Add configuration, such as registering blueprints or configuring databases, in app/__init__.py
• Commit and push often

Github Setup

1. Choose one member to fork the Solar System API repo
2. Add all members to the forked repo as collaborators (through the repo settings)
3. All group members should clone this new, forked, group repo and cd into it
4. Discuss good git hygiene:
   • Make regular commits
   • Push commits before switching driver
   • Pull before starting to drive

Guidelines for Pair-Programming

• The driver is the person who is at the keyboard and mouse
• The navigator is the person who is thinking out loud, actively collaborating with the driver about the next step, and helping guide the development
• Trade-off driver and navigator roles often, at least daily, or every hour for longer work sessions.
• Take time to make sure you're on the same page

Project Directions

Part 1

1. Wave 01: Setup and Read
2. Wave 02: Read and 404s

Part 2

2. Wave 03: Connecting the Database, Read and Create Endpoints
3. Wave 04: Read, Update, and Delete
4. Wave 05: Review and Refactor
5. Wave 06: Writing Tests

Database Setup/Update

For Waves 04, 05, and 06, the new driver may need to setup or update their database. Follow these steps:

1. Pull down all new git commits
2. Activate the virtual environment
3. Create the database solar_system_development
4. Run flask db upgrade
5. Run flask run to confirm that the API is running as expected