Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jabedzaman/avocado
SAAS starter with complete authentication, authorization, analytics, internalization, payment integrations, serverless deployment, etc
https://github.com/jabedzaman/avocado
nestjs nextjs postgres prisma redux-toolkit saas shadcn starter-kit
Last synced: 2 months ago
JSON representation
SAAS starter with complete authentication, authorization, analytics, internalization, payment integrations, serverless deployment, etc
- Host: GitHub
- URL: https://github.com/jabedzaman/avocado
- Owner: jabedzaman
- Created: 2022-07-24T10:59:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-02T21:25:49.000Z (7 months ago)
- Last Synced: 2024-11-18T07:15:58.955Z (2 months ago)
- Topics: nestjs, nextjs, postgres, prisma, redux-toolkit, saas, shadcn, starter-kit
- Language: TypeScript
- Homepage: https://ransom.jabed.dev
- Size: 1.99 MB
- Stars: 19
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
ransom
Complete SAAS Starter Kit with Authentication, Authorization, Internationalization, payment gateway, and more.
> [!WARNING]
> This project is still under development and not ready for production use. Please do not use it in production until the stable release.
View Demo
·
Architecture
·
Support
We all have that one side project we're eager to launch. But setting up authentication, authorization, payment gateways, and other crucial features can be a real time sink. Enter Ransom, the ultimate SaaS starter kit that accelerates your launch. Packed with all the must-have features, Ransom helps you get your project off the ground in no time. WHOOSH!! 🚀
Supercharge your launch with Ransom today!
## Features
- [x] 🔐 **Authentication**: Login, Register, Forgot Password, Reset Password, Email Verification, Social Login with Google, Facebook, Twitter, and GitHub
- [ ] 🔑 **Authorization**: Role-based access control with permissions
- [ ] 🌍 **Internationalization**: Supports multiple languages with RTL support
- [ ] 💳 **Payment Gateway**: Stripe integration for subscription-based payment
- [x] 🌑 **Dark Mode**: Light and Dark mode support
- [x] 🌐 **SEO**: SEO friendly with meta tags and Open Graph support
- [x] 📱 **Responsive**: Mobile-friendly design
- [x] ⚡ **Performance**: Optimized for performance with lazy loading and caching
- [x] 👨💻 **Developer-friendly**: Easy to understand, clean code with detailed documentation
- [ ] ☁️ **Fully Serverless**: Deploy on Vercel, Netlify, or any serverless platform
- [ ] 📄 **Landing & Blog**: Landing page and blog with mdx support
- [ ] 📈 **Analytics**: Google Analytics integration
- [x] 🆓 **Open Source**: Fully open-source with MIT license
## Tech Stack
- [Next.js](https://nextjs.org) - The Server-Side Rendering React Framework
- [shadcn-ui](https://ui.shadcn.com) - UI Library
- [@reduxjs/toolkit](https://redux-toolkit.js.org) - The official, opinionated, batteries-included toolset for efficient Redux development
- [rtk-query](https://redux-toolkit.js.org/rtk-query/overview) - A powerful data fetching and caching tool
- [nestjs](https://nestjs.com) - A progressive Node.js framework for building efficient, reliable, and scalable server-side applications
- [prisma](https://prisma.io) - Next-generation ORM for Node.js and TypeScript
- [PostgreSQL](https://www.postgresql.org) - The World's Most Advanced Open Source Relational Database
- [Stripe](https://stripe.com) - Online payment processing for internet businesses
- [Vercel](https://vercel.com) - Develop. Preview. Ship.
## Folder Structure
```bash
.
├── .github
├── apps
│ ├── api (NestJS backend)
│ └── www (Next.js frontend)
├── docs
├── packages
│ └── types
├── .gitignore
├── .node-version
├── .npmrc
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── readme.md
└── turbo.json
```
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org) - JavaScript runtime
- [pnpm](https://pnpm.io) - Fast, disk space efficient package manager
- [PostgreSQL](https://www.postgresql.org) - The World's Most Advanced Open Source Relational Database
### Installation
1. Click on "Use this template" and then "Create repository from template" to create a new project using the Ransom template on GitHub.
2. Clone the repository to your local machine.
```bash
git clone
```
3. Install the dependencies.
```bash
pnpm install
```
4. Follow the instructions in the `apps/api/.env.example` and `apps/www/.env.example` files to set up the environment variables.
5. Start the development server.
```bash
pnpm start:dev
```
## Port Configuration
| App | Port |
| --- | --- |
| API | 3000 |
| WWW | 4000 |
## License
This project is open source and available under the [MIT License](/LICENSE).
## Security Vulnerabilities
If you discover a security vulnerability within Ransom, please send an e-mail to Jabed Zaman via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed. Please do not disclose security-related issues publicly until they have been addressed.