Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): typos #465

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Before submitting a PR, please make sure that all tests, linting and formatting
rules are passing.

We squash all PRs by default. You can request your PR commits to not be squashed
if the're well named and organized, and it would make sense to preserve their
if they're well named and organized, and it would make sense to preserve their
context.

To keep the repository clean, we may mark PRs as stale if there has been no
Expand Down
6 changes: 3 additions & 3 deletions SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ Update the `DATABASE_URL` variable to `postgres://passport_scorer:passport_score
Update the `CERAMIC_CACHE_SCORER_ID` variable to match a `SCORER_ID` you create from the scorer UI.
(You will have to complete all these setup steps first, then you will be able to create a `SCORER_ID` from the UI & update this variable.)

3. Create a new `.env` file in the `interface` directory & update the varaibles.
3. Create a new `.env` file in the `interface` directory & update the variables.
```shell
# From inside the interface/ directory
cp .env.example .env
```
Update the `NEXT_PUBLIC_PASSPORT_SCORER_ALCHEMY_API_KEY` varaible to an Alchemy API key you own. If you don't have one, you can create one for free [here](https://docs.alchemy.com/reference/api-overview)
Update the `NEXT_PUBLIC_PASSPORT_SCORER_ALCHEMY_API_KEY` variable to an Alchemy API key you own. If you don't have one, you can create one for free [here](https://docs.alchemy.com/reference/api-overview)


4. Run and build the `Dockerfile` from the root directory. The first time you run this, it will take
Expand Down Expand Up @@ -162,7 +162,7 @@ Copy the `.env.example` file:
cp .env.example .env
```

Update the `NEXT_PUBLIC_PASSPORT_SCORER_ALCHEMY_API_KEY` varaible to an Alchemy API key you own. If you don't have one, you can create one for free [here](https://docs.alchemy.com/reference/api-overview)
Update the `NEXT_PUBLIC_PASSPORT_SCORER_ALCHEMY_API_KEY` variable to an Alchemy API key you own. If you don't have one, you can create one for free [here](https://docs.alchemy.com/reference/api-overview)

To start the development server:

Expand Down
4 changes: 2 additions & 2 deletions examples/check-trusted-user-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ from Gitcoin passport. The app is built in Nextjs using `create-next-app` and Ch

## Getting Started

This repository contains source code to accompany a "trusted user app" walkthrouhg tutorial at [docs.gitcoin.co](https://docs.passport.gitcoin.co/building-with-passport/integration-guides/integrating-stamps-and-scorers).
This repository contains source code to accompany a "trusted user app" walkthrough tutorial at [docs.gitcoin.co](https://docs.passport.gitcoin.co/building-with-passport/integration-guides/integrating-stamps-and-scorers).

You can find step-by-step instructions for setting up and running this app in the tutorial.

Expand All @@ -25,7 +25,7 @@ npm run dev
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You will need a web3 wallet, ideally one that already owns a Gitcoin Passport with several
stamps.Otherwise, you won't be able to do very much with this app!
stamps. Otherwise, you won't be able to do very much with this app!

## Learn More

Expand Down
4 changes: 2 additions & 2 deletions examples/passport-gated-content-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ npm run dev

Open `http://localhost:3000` with your browser to see the result.

You will need a web3 wallet, ideally one that already owns a Gitcoin Passport with several stamps.Otherwise, you won't be able to do very much with this app!
You will need a web3 wallet, ideally one that already owns a Gitcoin Passport with several stamps. Otherwise, you won't be able to do very much with this app!

## Learn More

There is a walkthrough tutorial for this app coming soon...
There is a walkthrough tutorial for this app coming soon...
4 changes: 2 additions & 2 deletions load_tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

- `cd generate_test_auth_tokens`
- run `npm install`
- make sure to set the environent variables:
- make sure to set the environment variables:

```bash
export MNEMONIC='chief loud snack trend chief net field husband vote message decide replace'
Expand Down Expand Up @@ -48,7 +48,7 @@ or
To output results / stats in a CSV file, run k6 with the `--out` like:
`k6 run -e SCORER_API_KEY='iE7QwgX9.rx9XIXdkPwZUYAHditFMgFVKvDp428OH' -e SCORER_ID=24 --vus 10 --duration 120s --out csv=k6_metrics.csv test_scripts/scorer_api_script.js`

You can then use the `stats.ipynb` to analyse the results frm the `k6_metrics.csv` (after the run).
You can then use the `stats.ipynb` to analyse the results from the `k6_metrics.csv` (after the run).

## In cloud

Expand Down