-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
df0863c
commit b409ceb
Showing
1 changed file
with
85 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,91 @@ | ||
| # Saroh.io | ||
|
|
||
| Open source platform to create blogs, portfolios, and more. | ||
| Built with Next.js, Tailwind CSS, and Turbo Repo. Deployed on Vercel | ||
| Open source platform to create blogs, portfolios, and Storefronts. | ||
|
|
||
| You can find the docs at [docs.saroh.io](https://docs.saroh.io) and the marketing website at [saroh.io](https://saroh.io). | ||
| ## Tech Stack | ||
|
|
||
| > Please Note that this project is still in development and is not ready for production use. There might be changes in the code. I will be doing it in my free time. I will update more info about the use cases and how it works in the docs and will also add the roadmap soon. | ||
| - Next.js | ||
| - React | ||
| - TypeScript | ||
| - Prisma | ||
| - TailwindCSS | ||
| - Shadcn UI | ||
| - Vercel (for deployments and DNS management) | ||
| - S3 for storage | ||
| - My SQL database | ||
| - React Email for creating email UI | ||
| - Nodemailer for sending emails | ||
| - Next-auth V5 for authentication | ||
| - React Query for data fetching | ||
| - React Hook Form for form handling | ||
| - Zod for validation | ||
| - Turbo repo for monorepo management | ||
| - Aceternity UI for building marketing website | ||
| - Stripe for subscription management | ||
| - Nextra for documentation | ||
| - React table for tables | ||
| - Recharts for building charts | ||
|
|
||
| The application can be found at [app.saroh.io](https://app.saroh.io). | ||
| ## What will you learn from this project? | ||
|
|
||
| - How to build a full stack application from scratch | ||
| - How to use Next.js for building frontend applications | ||
| - How to use Prisma for managing database schema | ||
| - How to create Email templates and sending emails using nodemailer | ||
| - How to use React Query for data fetching | ||
| - How to use React Hook Form for form handling | ||
| - How to create beautiful marketing websites using Aceternity UI | ||
| - How to use Stripe for subscription management | ||
| - How to use Nextra for documentation | ||
| - How to use React table for displaying data in react | ||
| - How to use Recharts for building beautiful dashboards | ||
| - How to use Turbo repo for monorepo management | ||
| - How to write backend logic | ||
| - Using HTTP status codes, and HTTP request methods like: GET, POST, PUT, DELETE, PATCH. | ||
| - How to build a chatbot using NextJS | ||
| - How to use TailwindCSS for styling | ||
| - and a lot more things as the project grows. | ||
|
|
||
| # Folder structure: | ||
|
|
||
| ## `apps`: | ||
|
|
||
| - **admin**: Admin dashboard for admin(Coming Soon). Link: [https://admin.saroh.io](https://admin.saroh.io) | ||
| - **application**: Old application. Link: [https://app.saroh.io](https://app.saroh.io) | ||
| - **auth** Authentication app for saroh, handles login, signup, forgot password, etc.(in-progress), Link: [https://auth.saroh.io](https://auth.saroh.io) | ||
| - **chatbot**: Chatbot app for saroh, (Coming Soon), Link: [https://chatbot.saroh.io](https://chatbot.saroh.io) | ||
| - **dashboard**: Dashboard for users to manage their blogs, portfolios, etc. This is the current application.(in-progress), Link: [https://dashboard.saroh.io](https://dashboard.saroh.io) | ||
| - **docs**: Documentation app for saroh, (in-progress), Link: [https://docs.saroh.io](https://docs.saroh.io) | ||
| - **ecom-templates**: E-commerce templates for saroh, (Coming Soon), Link: [https://templates.saroh.io](https://templates.saroh.io) | ||
| - **email-service**: Email service for saroh, (Coming Soon), Link: [https://emails.saroh.io](https://emails.saroh.io) | ||
| - **sites**: Application to render users blogs, portfolios, etc. (Coming Soon), Link: [https://\*.saroh.site](https://*.saroh.site) | ||
| - **ui**: UI components for saroh, (Coming Soon), Link: [https://ui.saroh.io](https://ui.saroh.io) | ||
| - **web**: Saroh website(saroh.io), (Coming Soon), Link: [https://saroh.io](https://saroh.io) | ||
|
|
||
| ## `packages`: | ||
|
|
||
| - **auth**: Auth package for saroh to provide authentication services to all apps. Package: **(@saroh/auth)** | ||
| - **charts**: Charts package for saroh to provide charts to all apps. Package: **(@saroh/charts)** | ||
| - **chatbot**: Chatbot package for saroh to provide chatbot services to all apps. Package: **(@saroh/chatbot)** | ||
| - **database**: Database package for saroh to provide database schema to all apps. Uses `Prisma` to handle database schema. Package: **(@saroh/database)** | ||
| - **emails**: The email templates UI for saroh, based on `react-email`. Package: **(@saroh/email)** | ||
| - **eslint-config-custom**: Custom eslint config for saroh | ||
| - **tailwind-config**: Custom tailwind config for saroh | ||
| - **templates**: Templates package for saroh to provide templates to all apps. Package: **(@saroh/templates)** | ||
| - **tsconfig**: Custom tsconfig for saroh. | ||
| - **ui**: UI package for saroh to provide UI components to all apps. Package: **(@saroh/ui)** | ||
| - **utils**: Utils package for saroh to provide utility functions to all apps. Package: **(@saroh/utils)** | ||
|
|
||
| We are just getting started and these are just a few things we have covered. This project will be updated regularly and I hope it will inspire you to learn more about full stack development. I will try to make it better and more helpful to everyone. I haven't planned of commercializing it yet, and I think even if someone learns from it and builds projects on top of it, that would be a great thing for me. More details will be added soon. | ||
|
|
||
| ### Terms of Use | ||
|
|
||
| > **Please note**: this project is for educational purpose only and the code here is not 100% reliable for use in production. It can help you understand how to build something but it does guarantee that it will be safe to use in production. | ||
| > You can use it however you want to. You just have to let me know if you are using it or it helped you in any way possible. Using this is free of charge. | ||
| > I will add more details and scope of the project and how to use. | ||
| ### Support the development | ||
|
|
||
| Feel free to contact me on: <[email protected]> or <[email protected]>. |