Skip to content

Workshop and getting started content for organizations using GitHub

License

Notifications You must be signed in to change notification settings

github-samples/pets-workshop

 
 

Pets workshop

This repository contains the project for two guided workshops to explore various GitHub features. The project is a website for a fictional dog shelter, with a Flask backend using SQLAlchemy and Astro frontend using Svelte for dynamic pages.

Getting started

Get started learning about development with GitHub!

Development

Quick Start

To run the application:

./scripts/start-app.sh

This will start both the Flask backend (port 5100) and Astro frontend (port 4321).

Project Structure

  • client/ - Astro frontend with Svelte components
  • server/ - Flask backend with SQLAlchemy models
  • scripts/ - Development and testing scripts

License

This project is licensed under the terms of the MIT open source license. Please refer to MIT for the full terms.

Maintainers

You can find the list of maintainers in CODEOWNERS.

Support

This project is provided as-is, and may be updated over time. If you have questions, please open an issue.

Contributors 13