https://github.com/tmc/the-aivengers
https://github.com/tmc/the-aivengers
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tmc/the-aivengers
- Owner: tmc
- License: isc
- Created: 2023-07-22T22:03:01.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-27T17:49:58.000Z (almost 3 years ago)
- Last Synced: 2025-03-15T16:23:50.047Z (over 1 year ago)
- Language: Python
- Size: 9.66 MB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hackathon Starter Project
Welcome to the Hackathon Starter Project! This project is designed to give you a comprehensive set of templates to kickstart your coding journey, whether you're participating in a hackathon or just exploring on your own. It features a variety of backends and a frontend template, plus a gateway and Docker compose examples to tie everything together.
It's meant to get you from zero to having LLM-backed apps in just a few minutes!
## Getting Started
### Pre-requisites
This codebase requires the following tools to be present on your machine.
- [Docker](https://docs.docker.com/get-docker/)
- [Homebrew](https://brew.sh/)
### Running the Project
To get started with this project, clone the repository to your laptop.
```shell
$ git clone https://github.com/tmc/hackathon-starter.git
```
```shell
$ cd hackathon-starter
$ make run-sample-service-set
```
https://www.loom.com/share/133f6c34c17445628dfd6f5cd0704ac3
You should see this in the [Tilt UI](http://localhost:10350/r/react-frontend/overview):
The [React Frontend](http://localhost:3000):
The [Apollo GraphQL Sandbox](http://localhost:3000/sandbox):
### Accessing Services
- [10350](http://localhost:10350/r/react-frontend/overview) - The Tilt Harness (with the react-frontend selected).
- [3000](http://localhost:3000) - React Frontend.
- [3000](http://localhost:3000/sandbox) - GraphQL Sandbox.
- [4000](http://localhost:4000) - GraphQL Gateway.
- [5432](https://www.postgresql.org/docs/current/app-psql.html) - PostgreSQL database.
- [8000](http://localhost:8000/graphql) - Python Graphene backend.
- [8080](http://localhost:8080) - Go GraphQL backend
- [6379](https://redis.io/docs/ui/cli/#command-line-usage) - Redis Server.
- [6380](http://localhost:6380) - RedisInsight web UI.
- [16686](http://localhost:16686) - [Jaeger](https://www.jaegertracing.io/docs/1.45/getting-started/) web UI (distributed trace viewer).
**note**: Run `make port-doctor` to see if these ports are already bound by another process.
## GraphQL Federated Gateway
A key component in this stack is [Apollo Router](https://www.apollographql.com/docs/router/) which enables aggregating across several backends.
As long as a backend component has a `schema.graphql` file that it can fulfill requests will get to them. See the `make generate` target under [./gateway](./gateway).
Showing the result of
```graphql
query User($userId: ID!) {
user(id: $userId) {
id
username
description
}
}
```
With arguments of
```json
{"userId": 42}
```
Returning
```json
{
"data": {
"user": {
"id": "42",
"username": "user42 (from the python graphene backend)",
"description": "User 42 description here. (coming from the Go backend)"
}
}
}
```
## Directory Structure
The project is divided into various directories, each corresponding to a distinct part of the application. Here's a quick breakdown:
- [`./fastapi-backend`](./fastapi-backend): This is a backend service built using FastAPI, a high-performance Python framework for building APIs.
- [`./graphene-backend`](./graphene-backend): This is another backend service built with Flask and Graphene. Flask is a lightweight web application framework for Python, while Graphene is a Python library for building GraphQL APIs in Python.
- [`./go-graphql-backend`](./go-graphql-backend): This directory contains a backend service implemented in Go with the help of gqlgen, a Go library for building GraphQL servers. It includes support for subscriptions.
- [`./react-frontend`](./react-frontend): This is a frontend application built with React and TypeScript. React is a JavaScript library for building user interfaces, and TypeScript is a statically typed superset of JavaScript that adds optional types.
- [`./gateway`](./gateway): This directory contains a sample setup that combines multiple backend services.
- [`./dev-harness`](./dev-harness): This directory contains examples of `docker-compose.yml` files showing how to configure Docker Compose to run the various components of this project together.
Each directory contains a `README.md` file with more detailed information about that part of the project.
## Further Reading
- [FastAPI Documentation](https://fastapi.tiangolo.com/)
- [Flask Documentation](https://flask.palletsprojects.com/)
- [Graphene Documentation](https://docs.graphene-python.org/)
- [Gqlgen Documentation](https://gqlgen.com/)
- [React Documentation](https://reactjs.org/)
- [Docker Compose Documentation](https://docs.docker.com/compose/)
We hope this gives you a good introduction to the Hackathon Starter Project. Happy coding!