Ethproofs

App local development

pnpm install
pnpm dev

Supabase local development

Install the supabase CLI & docker.

supabase login
supabase start

Create a .env.local file with the generated API URL and anon key.

NEXT_PUBLIC_SUPABASE_URL=the-generated-API-URL
NEXT_PUBLIC_SUPABASE_ANON_KEY=the-generated-anon-key

Supabase migrations workflow

See https://supabase.com/docs/guides/cli/local-development#database-migrations

Supabase seed workflow

See https://supabase.com/docs/guides/cli/local-development#database-seeds

Typescript

After a change in the database schema, run the following command to regenerate the typescript types.

pnpm db:types

More info: https://supabase.com/docs/reference/javascript/typescript-support

Seed

Generate the seed file by running the script and then reset the database.

The script will automatically install dependencies and pipe the results into supabase/seed.sql.

pnpm db:seed
pnpm db:reset

Sync the database schema with the seed file.

pnpm seed:sync

Cron jobs

This project uses the pg_cron extension within Supabase to automate important database maintenance tasks.

You must ensure that the Cron extension is installed and enabled in your Supabase project for these jobs to run correctly.

Requirements

1. Install the pg_cron extension Follow the Supabase pg_cron documentation to enable the extension in your project.

2. Schedule the required jobs Use the SQL commands below to schedule each job in your Supabase database.

---

List of required cron jobs

• Update cluster active status daily Updates the is_active status of clusters every day at midnight:

  select cron.schedule(
      'update-cluster-active-status',
      '0 0 * * *',
      'select update_cluster_active_status();'
  );
  

More info: https://supabase.com/docs/guides/cron

Contributing

We welcome contributions from the community! Please read our CONTRIBUTING.md for:

• Contribution requirements and workflow
• Code standards and commit message conventions
• Pull request process
• How to report bugs and request features

Quick Start for Contributors

1. Fork and clone the repository
2. Follow the local development setup above
3. Create a feature branch
4. Make your changes following our code standards
5. Commit using conventional commits format
6. Push and create a pull request

New contributors should start with issues labeled good first issue.

License

Ethproofs is dual-licensed under your choice of:

• MIT License
• Apache License 2.0