README.md

XD Internal

Internal website for managing membership, governance, and other DAO tings.

About

This app uses a bunch of frameworks/services to bootstrap and speed up development 🥴:

App

• Next.js as the app framework, including API.

Authentication

• NextAuth for user authentication.
• RainbowKit for wallet connection.
• Magic Link for email OTP login, possibly as a wallet provider in the future too for onboarding users without wallets.

Styling

• TailwindCSS as a CSS framework.
• daisyUI for Tailwind components and themes.

Storage

• PlanetScale for MySQL database.
• AWS S3 for storing/serving assets.

Getting Started

Please feel free to clone this repo, and open a PR or issue for any fixes / features :)

Prerequisites

• Copy .env.template to a local .env file.
• Contact Terrance on Telegram for env vars and access setup (until we have better password/auth management software like 1password lol)

Running server

Run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

Deployment

This project is deployed on Vercel. There are no deployment envs or steps set up other than merging to main, but feel free to help add those ty.

Database Management

This app uses PlanetScale as an easy-to-setup MySQL platform. See packages/database README for instructioins on how to update db schemas.