JueJu is an AI-powered Chinese poetry platform that allows users to explore, create and share Chinese 绝句 or jué jù, a form of Chinese poetry that consists of four lines of five or seven characters each. It leverages the power of GenAI to generate custom poetry based on categories and themes provided by the user. The platform allows users to share their creations with the community and explore poetry created by others.
JueJu is a full-stack application with a frontend built in React and TypeScript, and a backend developed in Go. The frontend makes use of the Vite build tool for faster builds. It also uses Material UI for styling and React Router for navigation.
The backend is a Go-based service, build with OpenAPI for API documentation and validation, Auth0 for authentication, a Redis/PostgreSQL database setup for data storage.
The generation of poetry is powered by the sleeper-service, a Go microservice that generates handles GenAI requests with the OpenAI API.
Both frontend and backend are containerized using Docker, build with GitHub Actions and pushed to GitHub Container Registry. The production app is deployed to my homelab, a local Kubernetes cluster built on Rasberry Pi's. The website is exposed via a Cloudflare Argo Tunnel.
TODO: talk about the architecture of the app, the services, and the data flow.
- RabbitMQ vs Kafka vs ActiveMQ vs Redis for message broker
The frontend is bootstrapped with Vite, a modern front-end build tool that offers faster and leaner development experience for modern web projects. It uses React as the UI library and TypeScript for static type checking. The project structure is organized in a modular way, with separate directories for components and pages.
Here are a list of the key libraries and tools used in the frontend:
- React: A JavaScript library for building user interfaces.
- Vite: A build tool that aims to provide a faster and leaner development experience for modern web projects.
- Material-UI: A popular React UI framework that provides a set of components and styles for building responsive web applications.
- React Router: A routing library for React that enables navigation and URL handling in a React application.
- styled-components: A CSS-in-JS library that allows you to write CSS code inside your JavaScript components.
The backend service is written in Go, a statically typed, compiled language that is efficient for building scalable and reliable web services.
Here are a list of the key libraries and tools used in the backend:
- Fiber: Express inspired web framework for Go.
- oapi-codegen: A command-line tool and library to convert OpenAPI specifications to Go code
- Auth0: A flexible, drop-in solution to add authentication and authorization services to your applications.
- Redis: An open-source, in-memory data structure store used as a database, cache, and message broker.
- PostgreSQL: A powerful, open-source object-relational database system.
The project includes scripts for version management, including scripts for getting the latest tag and incrementing major, minor, and patch versions. These are managed by a Taskfile and can be found at the project root.
The Docker images for the frontend and backend are built and pushed to the GitHub Container Registry using GitHub Actions. The workflow is defined in the .github/workflows directory and is triggered whenever a new semver release tag is created.
This project is licensed under the Apache License, Version 2.0. For more details, see the LICENSE file.