Skip to content

Faucet milestone delivery #1 #573

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.

Sign up for GitHub

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

Merged
Noc2 merged 1 commit into from
Oct 13, 2022
Merged

Faucet milestone delivery #1 #573

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions deliveries/Faucet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Milestone Delivery :mailbox:

**The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/milestone-deliverables-guidelines.md).**

* **Application Document:** [https://github.com/w3f/Grants-Program/blob/master/applications/Faucet.md](https://github.com/w3f/Grants-Program/blob/master/applications/Faucet.md)
* **Milestone Number:** 1

**Deliverables**

| Number | Deliverable | Link | Notes |
| ------------- | ------------- | ------------- |------------- |
| 0a. | License | [GitHub repo link](https://github.com/karooolis/sybil-resistant-substrate-faucet/blob/main/LICENSE) | Apache 2.0 license included |
| 0b. | Documentation | [GitHub repo link](https://github.com/karooolis/sybil-resistant-substrate-faucet/blob/main/README.md) | Documentation contains instructions for how to run, deploy and test one's own faucet. |
| 0c. | Testing Guide | [GitHub repo link](https://github.com/karooolis/sybil-resistant-substrate-faucet#testing) | Guide on how to run unit, integration and E2E tests. |
| 0d. | Article | [Google Docs link](https://docs.google.com/document/d/1PKMPsfVBZx7TPq0IIS6fWd15Fs8d8HgUAaFHuA18Pao/edit?usp=sharing) | |
| 1. | User Interface | [GitHub repo link](https://github.com/karooolis/sybil-resistant-substrate-faucet/blob/main/pages/index.tsx) | |
| 2. | Authentication | [GitHub repo link](https://github.com/karooolis/sybil-resistant-substrate-faucet/blob/main/pages/api/auth/%5B...nextauth%5D.ts) | Authentication handler. Authentication can be done via Twitter or GitHub providers. |
| 3. | User status | [GitHub repo link](https://github.com/karooolis/sybil-resistant-substrate-faucet/blob/main/pages/api/claim/status.ts) | API endpoint returning whether a given user has already claimed tokens. |
| 4. | Faucet drip | [GitHub repo link](https://github.com/karooolis/sybil-resistant-substrate-faucet/blob/main/pages/api/claim/new.ts) | API endpoint for claiming tokens. |

**Additional Information**

The demo faucet can be viewed on https://sybil-resistant-substrate-faucet.vercel.app/.