https://github.com/colburncodes/social
Social is a boilerplate that you can use for an unlimited number of projects. Whether you're trying to learn how to structure your own app or want to rapidly spin up a number of features, it sets you up with a powerful set of features.
https://github.com/colburncodes/social
Last synced: 7 months ago
JSON representation
Social is a boilerplate that you can use for an unlimited number of projects. Whether you're trying to learn how to structure your own app or want to rapidly spin up a number of features, it sets you up with a powerful set of features.
- Host: GitHub
- URL: https://github.com/colburncodes/social
- Owner: colburncodes
- Created: 2023-10-17T00:01:44.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-18T00:51:18.000Z (over 1 year ago)
- Last Synced: 2024-10-20T11:38:09.133Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://staging.socialio.site/
- Size: 44.6 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Social
Introduction •
Features •
How to run it •
Tech stack •
Author •
License
## 📖 Introduction
Social was built on the idea that anyone, anywhere in the world can share
and monetize their passions. Our vision: a world where passions create connections across
continents.
Made with [Blitz](https://github.com/blitz-js/blitz).
---
## 📦 Features
- [x] Authentication and Authorization
- [x] Multi-tenancy
- [x] Payments Integration [Lemon Squeezy](https://docs.lemonsqueezy.com/api#test-mode)
- [x] Event Monitoring [Log Snag](https://logsnag.com/)
- [ ] Billing
- [ ] Orders
- [x] User activity
- [ ] Subscriptions [Subscriptions](https://docs.lemonsqueezy.com/api/subscriptions)
- [ ] Subscription plans
- [x] User Roles
- [ ] Notifications
- [x] Email prod env using [Resend](https://resend.com/) and [React Email](https://react.email/)
- [x] Welcome Email
- [x] Forgot Password
- [x] Password Reset
- [x] Contact Email
- [ ] Email staging env using [MailTrap](https://api-docs.mailtrap.io/docs/mailtrap-api-docs/5tjdeg9545058-mailtrap-api)
- [x] Email testing env using [Nodemailer](https://nodemailer.com/about/)
- [ ] Discord
- [ ] Browser / in-app
- [x] Admin Panel
- [ ] Announcements
- [ ] Invite system
- [ ] Cron jobs
- [x] Testing - [Vitest](https://vitest.dev/)
---
## 🛠️ How to run it
Clone Project
```bash
git clone https://github.com/colburncodes/social.git
```
Navigate to project directory
```bash
cd social
```
Install dependencies
```bash
npm install
```
Create a `.env` file in root directory
```
DATABASE_URL
RESEND_API_KEY
NODE_MAILER_USER
NODE_MAILER_PASS
UPLOADTHING_SECRET
UPLOADTHING_APP_ID
LEMONSQUEEZY_WEBHOOK_SECRET
LEMONSQUEEZY_API_KEY
LEMONSQUEEZY_STORE_ID
LEMONSQUEEZY_VARIANT_ID
LOGSNAG_API_KEY
NEXT_PUBLIC_LOGSNAG_CLIENT_TOKEN
```
Start the server
```bash
npm run dev
```
Start Prisma Studio
```bash
npm run studio
```
## Tech Stack
The following tools were used in the construction of the project:
- **[mantine](https://ui.mantine.dev/)**
- **[blitz](https://github.com/blitz-js/blitz)**
- **[prisma](https://www.prisma.io/nextjs)**
- **[postgresql](https://www.postgresql.org/)**
- **[railway](https://railway.app/)**
---
## Author
---
## License
This project is under the license [MIT](./LICENSE).
Made with ❤ by Colburn 👋🏽 [Get in Touch!](mailto:hello@whocolburn.com)
