diff --git a/README.md b/README.md index e215bc4..e57d22f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,24 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). +# SaaS template + +This is not gonna make You rich, but it sure as hell will save you a lot of time! + +This is production ready setup for Convex and Next SaaS. + +## Features + +- Auth +- Stripe +- Backend/Frontend Tests +- CICD +- shadcn/create UI templte +- accurate instructions + +## Development process + +### Environments + +- Dev cloud environment - based on `develop` branch +- Prod cloud environment - based on `main` branch ## Getting Started @@ -15,22 +35,3 @@ bun dev ``` Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.