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

docs : add system design 🌵 (#8) #15

Merged
merged 2 commits into from
Feb 29, 2024
Merged
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
41 changes: 9 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">
<br>
<a href="">
<a href="https://github.com/Samuellyworld/anchor-crowdfund">
<img src="./public/crowdfund.png" alt="crowdfund" width="130" height="130" />
</a>
<br>
Expand All @@ -20,7 +20,7 @@

<p align="center">
<a href="#-about">About</a> •
<a href="#-system-design">System Design and Architecture</a> •
<a href="#-system-design">Architecture</a> •
<a href="#-features">Features</a> •
<a href="#-folder-structure">Folder Structure</a> •
<a href="#-api-documentation">Documentation And Testing</a> •
Expand All @@ -29,35 +29,12 @@
</p>

## 📝 About

Exploring the development of a crowdfunding smart contract on the Solana blockchain, leveraging the Rust programming language and the Anchor framework. Crowdfunding has emerged as a popular method for raising funds for various projects, initiatives, and charitable causes, and blockchain technology introduces new possibilities for enhancing transparency, security, and efficiency in this process.

User Interface
┌───────────────┐ ┌───────────────┐ ┌───────────────┐
│ Frontend │ │ Frontend │ │ Frontend │
└───────┬───────┘ └───────┬───────┘ └───────┬───────┘
│ │ │
▼ ▼ ▼
┌───────────────┐ ┌───────────────┐ ┌───────────────┐
│ User Wallet │ │ User Wallet │ │ User Wallet │
└───────────────┘ └───────────────┘ └───────────────┘
│ │ │
└───────────────┬──────────┼───────────────┬──────────┼──────────────┐
▼ │ ▼ │ │
┌───────────────┐ │ ┌───────────────┐ │ Smart │
│ Solana RPC │ │ │ Solana RPC │ │ Contracts │
└───────────────┘ │ └───────────────┘ │ │
│ │ │ │ │
└──────────┼──────────────┼──────────┼───────────────┘
▼ ▼ │
┌─────────────────────────┐ │
│ Anchor Lang Program │◀──────┘
└─────────────────────────┘
│ │ │
│ │ │
┌────────────┘ │ └────────────┐
│ │ │
┌────────────────┐┌────────────────┐┌────────────────┐
│ Create ││ Withdraw ││ Donate │
│ Function ││ Function ││ Function │
└────────────────┘└────────────────┘└────────────────┘
## 🏛️ Architecture
<p>
<br>
<img src="./public/system-design.png" alt="system design"/>
<br>
</p>

Binary file added public/system-design.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading