gabriel-frattini / sideclub

A social network that allows members to share a sideproject idea and invite other members to join them or join someone else. 👥

Sideclub 👥 💭

sideclub is a simple social network that allows members to share a sideproject idea and invite other members to join them or request to join someone else. ✍

Features include a simple Markdown-based editor with preview, join and invite, comments and votes, image drag-and-drop and a clean responsive layout ⚡

Setup

Clone the repo

git clone https://github.com/gabriel-frattini/sideclub

Install dependencies

npm install

Create a database

• Create a PlanetScale database
• Create a connection string to connect to your database. Choose Prisma for the format
• Alternatively, your PlanetScale database and connection string can be generated using the pscale CLI or GitHub Actions. View instructions.
• Set up the environment variables:

cp .env.example .env

• Open .env and set the DATABASE_URL variable with the connection string from PlanetScale
• Create the database schema:

npx prisma db push

Configure authentication

• Configuring GitHub authentication

Sideclub uses NextAuth.js, so if you prefer to use one of the many providers it supports, you can customize your own installation. Simply update the lib/auth.ts file to add your own provider.

Running the app locally

npm run dev

Open http://localhost:3000 in your browser.

Authenticating with GitHub

Deploying to Vercel

One-click deploy:

⚠️ Remember to update your callback URLs after deploying.