Skip to content

Commit

Permalink
Merge pull request #64 from noir-lang/zpedro/spin-off-next-foundry
Browse files Browse the repository at this point in the history
chore: spinning off @crisgarner boilerplate, thanks Cris
  • Loading branch information
signorecello authored Dec 18, 2023
2 parents 0b662cd + b8db6fe commit aad1fff
Show file tree
Hide file tree
Showing 93 changed files with 10 additions and 13,407 deletions.
30 changes: 10 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,13 @@ authors or maintainers (@critesjosh, @signorecello) with your suggestion.

## Adding a new example project

If you are interested in adding a new example project, fork this repo and create a new branch for your work. Create a new folder with a descriptive name
for the project and include the following:

1. Noir circuits. This is a repo for getting started with writing zk programs in Noir, so the project
should include Noir programs.
2. A context in which the Noir programs run. This is not strictly necessary as it can be helpful to
have a basic Noir project just to show how to write some kind of circuit or use some feature of Noir,
but we often want an interface to generate and verify proofs. In the [hardhat example](next-hardhat),
this is a Javascript context and the
project shows how to do that using the Noir WASM files. In the [voting example](foundry-voting), you can see how to verify
proofs in an EVM context with the Solidity examples.
3. A README.md that describes what the example is and why it is helpful. Include the process for getting
started with the project (installation instructions, tips, gotchas, etc.). Be as descriptive as possible.
See the other projects for examples.
4. Automated testing. Ideally there are some tests as part of the project that can be used to check
the functionality. See the [voting pproject](foundry-voting) for an example--there are foundry tests
defined in the project and automated testing defined in the [Github workflows](.github/workflows/foundry-voting.yml) that will run the tests
on open PRs. This helps us ensure the reliability of the examples.

When you are ready for your work to be added to this repo, open a PR and request reviews from @critesjosh and @signorecello.
We are currently not accepting new contributions with starters. However, the Noir team encourages everyone to contribute to [awesome-noir](https://github.com/noir-lang/awesome-noir).

If you want to contribute with unique ideas, check out Awesome Noir to see what's been done so far, or what's the status of each of the projects. Some unique ideas for boilerplates or examples, if you don't know where to start, would be:

- Something integrating Angular
- A React Native starter
- A Svelte example
- A server-side-rendered Go or Python app

Basically anything that combines different technologies would be adding a lot to the ecosystem. If you'd like to discuss further, please message @signorecello or @critesjosh!
3 changes: 0 additions & 3 deletions next-foundry/.env.example

This file was deleted.

54 changes: 0 additions & 54 deletions next-foundry/.gitignore

This file was deleted.

4 changes: 0 additions & 4 deletions next-foundry/.gitmodules

This file was deleted.

178 changes: 0 additions & 178 deletions next-foundry/README.md

This file was deleted.

7 changes: 0 additions & 7 deletions next-foundry/circuits/Nargo.toml

This file was deleted.

2 changes: 0 additions & 2 deletions next-foundry/circuits/Prover.toml

This file was deleted.

1 change: 0 additions & 1 deletion next-foundry/circuits/Verifier.toml

This file was deleted.

3 changes: 0 additions & 3 deletions next-foundry/circuits/src/main.nr

This file was deleted.

Loading

0 comments on commit aad1fff

Please sign in to comment.