Skip to content

Latest commit

 

History

History
87 lines (66 loc) · 3.1 KB

README.md

File metadata and controls

87 lines (66 loc) · 3.1 KB
Raw

Guild.xyz interface

Code check

Open source interface for Guild.xyz -- a tool for platformless membership management.

Key dependencies overview

  • Framework
    • React with Next.js
  • Styling:
    • Chakra UI (migration to Tailwind CSS and Radix UI in progress)
    • Phosphor icons
    • Framer motion
  • State management:
    • SWR for fetching and caching
    • React Hook Form for form state
    • jotai for custom, simple global state
  • Testing:
  • Web3 related:
    • viem
    • wagmi for connection management
  • Data visualization, graphics:
    • visx
    • threejs
  • Deployment:
    • Vercel
  • Product analytics:
    • PostHog
  • Error monitoring:
    • BugSnag

Development

Running the interface locally

  1. npm i
  2. npm run dev
  3. If you don't have the secret environment variables, copy the .env.example as .env.local.

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

Warning

We've recently turned on strict and strictNullChecks tsconfig options, and decided to gradually fix the related TypeScript issues. The pre-commit hook will ignore these, but it is expected that you'll see different issues during local development. Feel free to open a PR if you fix some of them. 😉

For Windows users

If you encounter the error ERR_OSSL_EVP_UNSUPPORTED you can do :

export NODE_OPTIONS=--openssl-legacy-provider
npm i --force
npm run dev

Getting secret environment variables (for core team members):

  1. Get added to the team on Vercel
  2. npm i vercel@latest -g
  3. vercel link
  4. vercel env pull .env.local

Code guidelines

  • Always use design system values for styling when possible
  • Follow the file naming and folder structure pattern of the repository

Committing

  • Use Conventional Commits when applicable (recommended but not required)
  • Always use present tense in commit messages
  • Always review your changes before committing
  • A pre-commit hook type checks the code base. If it fails but you want to commit a WIP anyway use --no-verify

PR flow

  • Always create a draft PR right away when starting to work on a new branch
  • Vercel creates a unique link for each commit and each branch (showing the latest version of the branch), which you can get from the deployment page. Share the branch link with the team if needed
  • Always self-review changes in your PR before asking others. Refactor, clean up and add comments if needed. Repeat until there's no room for improvement that you see, or you've left a comment where there is
  • If you consider it ready, mark it as ready for review and ask for a review, or merge it by yourself if you have the permission