Welcome to the SaaScript monorepo! This project serves as a robust, scalable, and modular blueprint for building modern SaaS applications using the TypeScript and Node.js ecosystem. It's designed to provide a ready-to-use codebase and architectural foundation, allowing developers to focus on their unique business logic rather than boilerplate infrastructure.
Our vision is to offer a comprehensive, end-to-end SaaS framework that enables developers to rapidly build, customize, and self-host scalable, robust, and full-featured SaaS applications.
- AI-Assisted Development: Leveraging AI tools and processes to maximize efficiency across the entire software development lifecycle.
- Automation First: Automate repetitive and complex tasks with "single-command" scripts.
- Convention Over Configuration: Embrace structured frameworks (NestJS, React with Next.js) to enforce consistency and maintainability.
- Modular & Reusable: Designed with independent microservices and components for high reusability.
- API-First: Clear, consistent, and well-documented APIs for all services.
- Scalable & Resilient: Architected to handle high loads and ensure high availability.
- Security-First: Built with robust security practices at every layer.
- TypeScript-First: Prioritizing TypeScript for robust, scalable, and maintainable codebase.
- Backend: NestJS (TypeScript/Node.js)
- Databases: PostgreSQL (Transactional), DynamoDB (User Profiles)
- Caching/Session: Redis
- Messaging/Queues: RabbitMQ, Apache Kafka
- Frontend: React with Next.js Framework
- Deployment: Kubernetes (K8s) with Minikube for local dev
- Secrets Management: HashiCorp Vault
This monorepo is organized into the following top-level directories:
modules/: Houses individual backend microservices (e.g.,auth,billing,api-gateway).frontend/: Contains frontend applications (e.g.,frontend/webfor the public site,frontend/adminfor the admin panel).docs/: Comprehensive project documentation, architectural diagrams, and guides.scripts/: Root-level automation scripts for development, testing, and deployment.
The docs/ directory contains comprehensive guides and architectural overviews for the SaaScript project:
- AI-Assisted Workflow: Explains the collaboration model between human and AI co-developer.
- Architecture Overview: Details the finalized technology stack, core principles, and module design.
- Local Development Guide: Step-by-step instructions for setting up and running the project locally.
- Development Workflow: Outlines Git strategy, Pull Request (PR) process, and Conventional Commits.
- Project Management Approach: Describes the agile-inspired project management philosophy and tools.
- Code Style Guidelines: Defines coding standards for consistency and maintainability.
Refer to the docs/local-development.md guide for detailed instructions on setting up and running the project locally.
Our development workflow follows an AI-assisted agile methodology with a simplified Gitflow strategy and Conventional Commits. See docs/development-workflow.md for details.
We welcome contributions! Please refer to the pull request template and contribution guidelines.
This project is licensed under the MIT License. See the LICENSE file for more details.
Developed with the assistance of an AI Co-Developer.