opencollective/funders-dashboard

Open Collective Frontend template

This project is meant to provide the base layer to kickstart a new frontend project at Open Collective. The goal is to provide a solid foundation to build upon, while making sure we can bring back the code to the main Open Collective codebase whenever we need.

Currently included

• Next.js for server-side rendering and routing
• Styled Components for styling, with our custom design system plugged in
• Apollo for GraphQL queries
• ESLint for linting, with our custom config & Prettier
• Renovate for automated dependency updates
• A minimal Github Actions CI config
• A Vercel configuration for deployment and preview

To do:

• Jest for testing
• Depcheck
• Import frontend's fonts
• Husky pre-commit lint hook
• Replace all <Link><a> with our custom link component from frontend
• Invalidate OAuth tokens on logout

Getting Started

1. Fork the repository and install dependencies

Click on "Use this template" above (or alternatively, fork the repository) then clone it:

git clone https://github.com/opencollective/opencollective-frontend-template.git
cd opencollective-frontend-template
npm install

2. Configure your local environment

By default, the app will try to connect to the Open Collective staging API & frontend.

To run the template against your local frontend/api:

1. Create a new OAuth app
2. Run cp .env.local.example .env.local
3. Edit .env.local and set OPENCOLLECTIVE_OAUTH_APP_ID and OPENCOLLECTIVE_OAUTH_APP_SECRET to your OAuth app credentials

Learn more about the environment variables in NextJS: https://nextjs.org/docs/basic-features/environment-variables.

3. Start the application

To run your site locally (default: http://localhost:3004), use:

npm run dev

To run it in production mode, use:

npm run build
npm run start

Development process

• To update GraphQL schemas after an API change, run npm run graphql:update.

Deploy

1. Create a new project on Vercel, pick your forked repository.
2. On the "Configure Project" step, keep the default settings (NextJS), set the required Environment variables and click "Deploy":
   • NEXTAUTH_SECRET: a random string used to encrypt JWTs
   • OPENCOLLECTIVE_OAUTH_APP_ID: the ID of the OAuth app you created on the API
   • OPENCOLLECTIVE_OAUTH_APP_SECRET: the secret of the OAuth app you created on the API
   • NEXT_PUBLIC_OPENCOLLECTIVE_OAUTH_SCOPES: a comma separated list of OAuth scopes you want to request from the API (e.g. account,transactions)