Skip to content
This repository was archived by the owner on Apr 25, 2024. It is now read-only.

Commit 1eb6c8d

Browse files
cedoorcedoor
committed
chore: create initial web app
0 parents  commit 1eb6c8d

22 files changed

+1887
-0
lines changed

‎.github/pull_request_template.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- Please refer to our contributing documentation for any questions on submitting a pull request -->
2+
3+
## Description
4+
5+
<!--- Describe your changes in detail -->
6+
7+
## Related Issue
8+
9+
<!--- This project accepts pull requests related to open issues -->
10+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
11+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
12+
<!--- Please link to the issue here: -->
13+
14+
## Other information
15+
16+
<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->

‎.github/workflows/deploy.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: deploy
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
publish_docs:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v3
14+
15+
- name: Install Node.js
16+
uses: actions/setup-node@v3
17+
with:
18+
node-version: 18.x
19+
20+
- name: Get yarn cache directory path
21+
id: yarn-cache-dir-path
22+
run: echo "::set-output name=dir::$(yarn config get cacheFolder)"
23+
24+
- name: Restore yarn cache
25+
uses: actions/cache@v3
26+
id: yarn-cache
27+
with:
28+
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
29+
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
30+
restore-keys: |
31+
${{ runner.os }}-yarn-
32+
33+
- name: Install dependencies
34+
run: yarn
35+
36+
- name: Build app
37+
run: yarn build
38+
39+
- name: Deploy to GitHub Pages
40+
if: success()
41+
uses: crazy-max/ghaction-github-pages@v3
42+
with:
43+
fqdn: benchmarks.semaphore.appliedzkp.org
44+
build_dir: dist
45+
env:
46+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
15+
# Editor directories and files
16+
.vscode/*
17+
!.vscode/extensions.json
18+
.idea
19+
.DS_Store
20+
*.suo
21+
*.ntvs*
22+
*.njsproj
23+
*.sln
24+
*.sw?

‎CODE_OF_CONDUCT.md‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement.
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series
85+
of actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or
92+
permanent ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within
112+
the community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.0, available at
118+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
120+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
121+
enforcement ladder](https://github.com/mozilla/diversity).
122+
123+
[homepage]: https://www.contributor-covenant.org
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
https://www.contributor-covenant.org/faq. Translations are available at
127+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Contributing
2+
3+
:tada: Thank you for being interested in contributing to the Semaphore project! :tada:
4+
5+
Feel welcome and read the following sections in order to know how to ask questions and how to work on something.
6+
7+
All members of our community are expected to follow our [Code of Conduct](/CODE_OF_CONDUCT.md). Please make sure you are welcoming and friendly in all of our spaces.
8+
9+
We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. 👏
10+
11+
## Issues
12+
13+
The best way to contribute to our projects is by opening a [new issue](https://github.com/semaphore-protocol/benchmarks/issues/new/choose) or tackling one of the issues listed [here](https://github.com/semaphore-protocol/benchmarks/contribute).
14+
15+
## Pull Requests
16+
17+
Pull requests are great if you want to add a feature or fix a bug. Here's a quick guide:
18+
19+
1. Fork the repo.
20+
21+
2. Run the tests. We only take pull requests with passing tests.
22+
23+
3. Add a test for your change. Only refactoring and documentation changes require no new tests.
24+
25+
4. Make sure to check out the [Style Guide](/CONTRIBUTING#style-guide) and ensure that your code complies with the rules.
26+
27+
5. Make the test pass.
28+
29+
6. Commit your changes.
30+
31+
7. Push to your fork and submit a pull request on our `dev` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us.
32+
33+
## CI (Github Actions) Tests
34+
35+
We use GitHub Actions to test each PR before it is merged.
36+
37+
When you submit your PR (or later change that code), a CI build will automatically be kicked off. A note will be added to the PR, and will indicate the current status of the build.
38+
39+
## Style Guide
40+
41+
### Code rules
42+
43+
We always use ESLint and Prettier. To check that your code follows the rules, simply run the npm script `yarn lint`.
44+
45+
### Commits rules
46+
47+
For commits it is recommended to use [Conventional Commits](https://www.conventionalcommits.org).
48+
49+
Don't worry if it looks complicated, in our repositories, after `git add`, you can usually run the npm script `yarn commit` to make many of these steps interactive.
50+
51+
Each commit message consists of a **header**, a **body** and a **footer**. The **header** has a special format that includes a **type**, a **scope** and a **subject**:
52+
53+
<type>(<scope>): <subject>
54+
<BLANK LINE>
55+
<body>
56+
<BLANK LINE>
57+
<footer>
58+
59+
The **header** is mandatory and the **scope** of the header is optional.
60+
61+
#### Type
62+
63+
The type must be one of the following:
64+
65+
- feat: A new feature
66+
- fix: A bug fix
67+
- docs: Documentation only changes
68+
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
69+
- refactor: A code change that neither fixes a bug nor adds a feature (improvements of the code structure)
70+
- perf: A code change that improves the performance
71+
- test: Adding missing or correcting existing tests
72+
- build: Changes that affect the build system or external dependencies (example scopes: gulp, npm)
73+
- ci: Changes to CI configuration files and scripts (example scopes: travis, circle)
74+
- chore: Other changes that don't modify src or test files
75+
- revert: Reverts a previous commit
76+
77+
#### Scope
78+
79+
The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages).
80+
81+
#### Subject
82+
83+
The subject contains a succinct description of the change:
84+
85+
- Use the imperative, present tense: "change" not "changed" nor "changes"
86+
- Don't capitalize the first letter
87+
- No dot (.) at the end
88+
89+
#### Body
90+
91+
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
92+
93+
### Branch rules
94+
95+
- There must be a `main` branch, used only for the releases.
96+
- There must be a `dev` branch, used to merge all the branches under it.
97+
- Avoid long descriptive names for long-lived branches.
98+
- Use kebab-case (no CamelCase).
99+
- Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit).
100+
- Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow.
101+
- Use slashes to separate parts of your branch names.
102+
- Remove branch after merge if it is not important.
103+
104+
Examples:
105+
106+
```bash
107+
git branch -b docs/readme
108+
git branch -b test/a-feature
109+
git branch -b feat/sidebar
110+
git branch -b fix/b-feature
111+
```

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Ethereum Foundation
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)