Contributing to GitPOAP

Thank you for showing interest in contributing to GitPOAP! All your contributions are extremely valuable to the project!

Table of Contents

• Code of Conduct
• Ways to Contribute
• Contributing Workflow
• Getting Started Locally
• Scripts
  • Testing
  • GraphQl Code Generation

Code of Conduct

This project and everyone participating in it is governed by the gitpoap-fe Code of Conduct.

By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Ways to Contribute

• Improve documentation: Fix incomplete or missing docs, bad wording, examples or explanations.
• Give feedback: Please share how you use GitPOAP, what features are missing, and what is done well via our Discord.
• Contribute to the codebase: Propose new features via GitHub Issues or our Discord.
• Give us a code review: Help us identify problems with the source code or make GitPOAP more performant.
• Share GitPOAP: Share GitPOAP with anyone who might be interested!

Contributing Workflow

First, read our docs on contributing.

If this is your first time contributing to open source, congrats! We also recommend you read this guide to git best practices.

• Decide on what you want to contribute.
• If you want to implement a new feature, propose it on Discord before jumping into coding.
• After finalizing issue details, as you begin working on the code, please make sure to follow commit conventions.
• Run tests with npm test and submit a PR once all tests have passed.
• Get a code review and fix all issues noticed by the maintainer.
• If you cannot finish your task or if you change your mind – that's totally fine! Just let us know in the GitHub issue that you created during the first step of this process.
• Your PR is merged. You are awesome and we'll give you a GitPOAP to prove it!

Getting Started Locally

This is a Next.js project - view the docs for more info.

Example .env

NEXT_PUBLIC_SENTRY_DSN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
NEXT_PUBLIC_SENTRY_ENVIRONMENT='development'
SENTRY_AUTH_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
NEXT_PUBLIC_INFURA_ID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
NEXT_PUBLIC_REACT_APP_CLIENT_ID=xxxxxxxxxxxxxxxxxxxx
NEXT_PUBLIC_GITPOAP_API_URL=http://localhost:3001
NEXT_PUBLIC_PRIVY_APP_ID=xxxxxxxxxxxxxxxxxxxxxxxxx
NEXT_PUBLIC_AMPLITUDE_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

• Fork the repository, then clone or download your fork.
• Install dependencies with yarn – yarn
• To run the development server - yarn dev or npm run dev
  • Open http://localhost:3000 with your browser to see the result.
  • To run the development server with the production api: yarn dev:prod-api
• To start storybook – npm run storybook
  • View the component library on a deployed version of Storybook.

Scripts

All scripts can be located at main package.json.

Testing

yarn test: Run local jest tests

yarn test:ci: Run jest tests as they appear on ci

GraphQL Code Generation

yarn gql:generate-dev: Generate graphql hooks and types based on a local version of schema.graphql found in gitpoap-backend

yarn gql:generate: Generate graphql hooks and types based on the graphql schema found at api.gitpoap.io/graphql

Credits

A strong token of gratitude goes out to all of the investors, contributors, and supporters who helped build GitPOAP.

License

This project is licensed under the terms of the MIT license.