Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/midday-ai/v1
An open-source starter kit based on Midday.
https://github.com/midday-ai/v1
monorepo nextjs shadcn tailwind turborepo
Last synced: 1 day ago
JSON representation
An open-source starter kit based on Midday.
- Host: GitHub
- URL: https://github.com/midday-ai/v1
- Owner: midday-ai
- License: mit
- Created: 2024-08-29T14:25:54.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-07T10:49:28.000Z (3 months ago)
- Last Synced: 2024-11-19T19:08:54.300Z (24 days ago)
- Topics: monorepo, nextjs, shadcn, tailwind, turborepo
- Language: TypeScript
- Homepage: https://v1.run
- Size: 7.08 MB
- Stars: 3,175
- Watchers: 19
- Forks: 285
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- my-awesome-list - v1 - source starter kit based on Midday. | midday-ai | 3217 | (TypeScript)
README
Create v1
An open-source starter kit based on Midday.
Website ·
Issues ·
What's included ·
Prerequisites ·
Getting Started ·
How to use
Everything you need to build a production ready SaaS, it's a opinionated stack based on learnings from building Midday using the latest Next.js framework, it's a monorepo with a focus on code reuse and best practices that will grow with your business.
## What's included
[Next.js](https://nextjs.org/) - Framework
[Turborepo](https://turbo.build) - Build system
[Biome](https://biomejs.dev) - Linter, formatter
[TailwindCSS](https://tailwindcss.com/) - Styling
[Shadcn](https://ui.shadcn.com/) - UI components
[TypeScript](https://www.typescriptlang.org/) - Type safety
[Supabase](https://supabase.com/) - Authentication, database, storage
[Upstash](https://upstash.com/) - Cache and rate limiting
[React Email](https://react.email/) - Email templates
[Resend](https://resend.com/) - Email delivery
[i18n](https://next-international.vercel.app/) - Internationalization
[Sentry](https://sentry.io/) - Error handling/monitoring
[Dub](https://dub.sh/) - Sharable links
[Trigger.dev](https://trigger.dev/) - Background jobs
[OpenPanel](https://openpanel.dev/) - Analytics
[Polar](https://polar.sh) - Billing (coming soon)
[react-safe-action](https://next-safe-action.dev) - Validated Server Actions
[nuqs](https://nuqs.47ng.com/) - Type-safe search params state manager
[next-themes](https://next-themes-example.vercel.app/) - Theme manager
## Directory Structure
```
.
├── apps # App workspace
│ ├── api # Supabase (API, Auth, Storage, Realtime, Edge Functions)
│ ├── app # App - your product
│ ├── web # Marketing site
│ └── ...
├── packages # Shared packages between apps
│ ├── analytics # OpenPanel analytics
│ ├── email # React email library
│ ├── jobs # Trigger.dev background jobs
│ ├── kv # Upstash rate-limited key-value storage
│ ├── logger # Logger library
│ ├── supabase # Supabase - Queries, Mutations, Clients
│ └── ui # Shared UI components (Shadcn)
├── tooling # are the shared configuration that are used by the apps and packages
│ └── typescript # Shared TypeScript configuration
├── .cursorrules # Cursor rules specific to this project
├── biome.json # Biome configuration
├── turbo.json # Turbo configuration
├── LICENSE
└── README.md
```
## Prerequisites
Bun
Docker
Upstash
Dub
Trigger.dev
Resend
Supabase
Sentry
OpenPanel
## Getting Started
Clone this repo locally with the following command:
```bash
bunx degit midday-ai/v1 v1
```
1. Install dependencies using bun:
```sh
bun i
```
2. Copy `.env.example` to `.env` and update the variables.
```sh
# Copy .env.example to .env for each app
cp apps/api/.env.example apps/api/.env
cp apps/app/.env.example apps/app/.env
cp apps/web/.env.example apps/web/.env
```
4. Start the development server from either bun or turbo:
```ts
bun dev // starts everything in development mode (web, app, api, email)
bun dev:web // starts the web app in development mode
bun dev:app // starts the app in development mode
bun dev:api // starts the api in development mode
bun dev:email // starts the email app in development mode
// Database
bun migrate // run migrations
bun seed // run seed
```
## How to use
This boilerplate is inspired by our work on Midday, and it's designed to serve as a reference for real-world apps. Feel free to dive into the code and see how we've tackled various features. Whether you're looking to understand authentication flows, database interactions, or UI components, you'll find practical, battle-tested implementations throughout the codebase. It's not just a starting point; it's a learning resource that can help you build your own applications.
With this, you have a great starting point for your own project.
## Deploy to Vercel
Vercel deployment will guide you through creating a Supabase account and project.
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmidday-ai%2Fv1&env=RESEND_API_KEY,UPSTASH_REDIS_REST_URL,UPSTASH_REDIS_REST_TOKEN,SENTRY_AUTH_TOKEN,NEXT_PUBLIC_SENTRY_DSN,SENTRY_ORG,SENTRY_PROJECT,DUB_API_KEY,NEXT_PUBLIC_OPENPANEL_CLIENT_ID,OPENPANEL_SECRET_KEY&project-name=create-v1&repository-name=create-v1&redirect-url=https%3A%2F%2Fv1.run&demo-title=Create%20v1&demo-description=An%20open-source%20starter%20kit%20based%20on%20Midday.&demo-url=https%3A%2F%2Fv1.run&demo-image=https%3A%2F%2Fv1.run%2Fopengraph-image.png&integration-ids=oac_VqOgBHqhEoFTPzGkPd7L0iH6)
## Recognition
