Skip to content

Commit 78f1f0d

Browse files
MarvyNwaokobiaMarvyNwaokobia
committed
Initial commit from Create Next App
0 parents  commit 78f1f0d

29 files changed

Lines changed: 595 additions & 0 deletions

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Bug report
3+
labels: type:bug
4+
---
5+
6+
## Describe the bug
7+
[Clear description of what went wrong]
8+
9+
## To reproduce
10+
1. ...
11+
2. ...
12+
3. ...
13+
14+
## Expected behavior
15+
[What should happen]
16+
17+
## Actual behavior
18+
[What happens instead]
19+
20+
## Environment
21+
- OS:
22+
- Node / Rust version:
23+
- Network: testnet / mainnet

‎.github/ISSUE_TEMPLATE/wave_issue.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Wave issue
3+
about: Issue tagged for Stellar Wave contributors
4+
labels: status:wave-ready
5+
---
6+
7+
## What needs to be done
8+
[Exact description. What the end state looks like. Be specific.]
9+
10+
## Why this matters
11+
[One sentence on the value to the protocol.]
12+
13+
## Where to start
14+
- File(s) to look at: `src/...`
15+
- Related: #[issue or PR number]
16+
- Docs: [link if relevant]
17+
18+
## Definition of done
19+
- [ ] [Specific testable criterion]
20+
- [ ] Tests added / updated
21+
- [ ] Docs updated if behavior changed
22+
23+
## Estimated time
24+
[30 min · 2 hrs · half day]
25+
26+
## Required knowledge
27+
[Be honest. What does the contributor need to know?]

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## What this does
2+
[One paragraph. What changed and why.]
3+
4+
## Type
5+
- [ ] Bug fix
6+
- [ ] New feature
7+
- [ ] Refactor
8+
- [ ] Documentation
9+
- [ ] Tests
10+
11+
## Checklist
12+
- [ ] Tests pass locally
13+
- [ ] Docs updated (if behavior changed)
14+
- [ ] Tested on Stellar testnet (if contracts changed)
15+
- [ ] No new lint/clippy warnings
16+
- [ ] Issue linked
17+
18+
## Notes for reviewer
19+
[Optional context]

‎.github/workflows/ci.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: CI
2+
on: [push, pull_request]
3+
jobs:
4+
build:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- uses: actions/checkout@v4
8+
- uses: actions/setup-node@v4
9+
with: { node-version: '20' }
10+
- run: npm install
11+
- run: npm run build
12+
- run: npm run lint

‎.gitignore‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.*
7+
.yarn/*
8+
!.yarn/patches
9+
!.yarn/plugins
10+
!.yarn/releases
11+
!.yarn/versions
12+
13+
# testing
14+
/coverage
15+
16+
# next.js
17+
/.next/
18+
/out/
19+
20+
# production
21+
/build
22+
23+
# misc
24+
.DS_Store
25+
*.pem
26+
27+
# debug
28+
npm-debug.log*
29+
yarn-debug.log*
30+
yarn-error.log*
31+
.pnpm-debug.log*
32+
33+
# env files (can opt-in for committing if needed)
34+
.env*
35+
36+
# vercel
37+
.vercel
38+
39+
# typescript
40+
*.tsbuildinfo
41+
next-env.d.ts

‎AGENTS.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!-- BEGIN:nextjs-agent-rules -->
2+
# This is NOT the Next.js you know
3+
4+
This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in `node_modules/next/dist/docs/` before writing any code. Heed deprecation notices.
5+
<!-- END:nextjs-agent-rules -->

‎CLAUDE.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

‎CONTRIBUTING.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing to shielded-app
2+
3+
Welcome! We're thrilled that you want to contribute to the frontend of the Shielded Protocol.
4+
5+
## Contributor Tracks
6+
7+
### 1. Frontend Development (Next.js)
8+
- Setup: Install Node.js.
9+
- Build: `npm install && npm run build`
10+
- Dev: `npm run dev`
11+
- Good issues: Look for `layer:app` labels.
12+
13+
### 2. SDK & Core Logic (TypeScript)
14+
- Head over to `shielded-sdk`.
15+
- Good issues: Look for `layer:sdk`.
16+
17+
### 3. ZK Circuits & Contracts
18+
- Head over to `shielded-circuits` or `shielded-contracts`.
19+
20+
## Your First PR
21+
22+
1. Fork the repo.
23+
2. Create a branch: `git checkout -b feat/my-ui-change`.
24+
3. Make your changes and verify they look good.
25+
4. Run `npm run lint`.
26+
5. Submit a PR!
27+
28+
## PR Checklist
29+
30+
- [ ] Tests pass locally
31+
- [ ] Docs updated (if behavior changed)
32+
- [ ] UI is responsive and accessible
33+
- [ ] Issue linked
34+
35+
## Code of Conduct
36+
37+
We follow the Contributor Covenant. Be kind and professional.
38+
39+
## Wave Contributors
40+
41+
Check out [Wave-ready issues](../../issues?q=label%3Astatus%3Awave-ready) to earn points!

‎README.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# shielded-app
2+
3+
> Next.js frontend for the Shielded Protocol.
4+
5+
Part of [shielded-protocol](https://github.com/Shielded-Protocol) —
6+
private, compliant DeFi on Stellar.
7+
8+
[![CI](https://github.com/Shielded-Protocol/shielded-app/actions/workflows/ci.yml/badge.svg)](https://github.com/Shielded-Protocol/shielded-app/actions)
9+
[![Stellar Wave](https://img.shields.io/badge/Stellar-Wave-blue)](https://drips.network/wave/stellar)
10+
11+
## What this does
12+
13+
The Shielded App is the user-facing interface for the Shielded Protocol. It allows users to:
14+
- Connect their Freighter wallet.
15+
- Deposit assets into the shielded pool.
16+
- Manage their private portfolio of shielded notes.
17+
- Withdraw assets using zero-knowledge proofs generated in the browser.
18+
- Access an auditor dashboard for compliance tasks.
19+
20+
Built with Next.js 14, Tailwind CSS, and the Shielded SDK.
21+
22+
## Quickstart
23+
24+
```bash
25+
npm install
26+
npm run dev
27+
```
28+
29+
## Architecture
30+
31+
[Link to shielded-docs](https://github.com/Shielded-Protocol/shielded-docs)
32+
33+
## Contributing
34+
35+
See [CONTRIBUTING.md](./CONTRIBUTING.md).
36+
Browse [Wave-ready issues](../../issues?q=label%3Astatus%3Awave-ready).
37+
38+
## License
39+
40+
MIT

‎SECURITY.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Security Policy
2+
3+
## Supported versions
4+
We currently support the latest version only.
5+
6+
## Reporting a vulnerability
7+
Please do NOT file a public GitHub issue for security vulnerabilities.
8+
9+
Email: security@shielded-protocol.org with:
10+
- Description of the vulnerability
11+
- Steps to reproduce
12+
- Potential impact
13+
14+
We will respond within 48 hours and coordinate disclosure.

0 commit comments

Comments
 (0)