https://github.com/RhysSullivan/tenant-kit
A collection of documentation, components, and resources for building multi-tenant applications.
https://github.com/RhysSullivan/tenant-kit
Last synced: 4 months ago
JSON representation
A collection of documentation, components, and resources for building multi-tenant applications.
- Host: GitHub
- URL: https://github.com/RhysSullivan/tenant-kit
- Owner: RhysSullivan
- Created: 2024-07-06T23:59:54.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-26T20:35:38.000Z (4 months ago)
- Last Synced: 2024-10-26T21:12:12.055Z (4 months ago)
- Language: TypeScript
- Homepage: https://tk.rhys.dev
- Size: 208 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - RhysSullivan/tenant-kit - A collection of documentation, components, and resources for building multi-tenant applications. (TypeScript)
README
# Tenant Kit
A toolkit for building multi-tenant applications. The goal of this project is to provide components, documentation, and utilities for handling custom domains, authentication, and customization across multiple tenants.
This is a highly work in progress project being built in public, it will be incomplete and there will be lots of iteration.
Open issues, PRs, and tweet feedback at me to make this better.
## Planned topics
Domains
- Custom domains i.e tenant.example.com
- Subpaths i.e example.com/tenant
- Using a custom domain as a handle i.e Bluesky (ATProtocol)
Customization
- Supporting custom HTML, CSS, and JavaScript
- Adding built in support for most analytics providers
Authentication
- Auth across subdomains, subpaths, and custom domains
Hosting
- Multi tenancy on Vercel
- Multi tenancy on Cloudflare
- Multi tenancy on a $5 VPS
## Project Structure
```
.
├── kit/ # Core components and utilities
├── www/ # Documentation and demo site
```
## Getting Started
1. Install dependencies:
```bash
pnpm install
```
2. Run the development server:
```bash
pnpm dev
```
3. Open [http://localhost:3000](http://localhost:3000) to view the documentation.
## Documentation
The documentation site is built using [Fumadocs](https://fumadocs.vercel.app) and includes:
- Component examples
- API documentation
- Integration guides
- Deployment instructions
## Contributing
1. Fork the repository
2. Create a feature branch
3. Submit a pull request
## Support
For support or sponsorship inquiries:
- Twitter: [@rhyssullivan](https://twitter.com/rhyssullivan)
- Email: [email protected]
## Tech Stack
- Next.js 15.0.0
- React (Canary)
- TypeScript
- Tailwind CSS
- Radix UI
- React Query
- Fumadocs
The project uses a monorepo structure with PNPM workspaces for package management.