Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fatiudeen/Aqua-Stark

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Aqua Stark Banner

🌊Aqua Stark 🐠

Aqua Stark is a Web3 game on StarkNet where players can collect, raise and evolve fish in a decentralized ecosystem. 🏝️🎮

🚀 Features

✔️ Fish breeding and evolution with unique genetics.
✔️ Decentralized Marketplace to buy and sell fish and decorations.
✔️ True asset ownership thanks to StarkNet and Cairo.
✔️ Aquarium customization with exclusive items and expansions.
✔️ Special events and tournaments with rare fish and rewards.

🛠️Technologies

  • Front: React.js + Vite + TailwindCSS
  • Blockchain: Dojo Engine
  • Monorepo Management: pnpm workspaces

📂Project Architecture

/AQUA-STARK
│── /client                # Web client (frontend)
│   ├── /node_modules      # Dependencies
│   ├── /public            # Static assets
│   ├── /src               # Frontend source code
│   ├── .gitignore
│   ├── README.md          # Frontend documentation
│   ├── package.json       # Dependencies and scripts
│   ├── vite.config.ts     # Vite configuration
│── /contract              # Smart contracts and game logic
│   ├── /src               # Smart contract source code
│   ├── .gitignore
│   ├── README.md          # Backend documentation
│   ├── LICENSE            # Project license
│   ├── Scarb.toml         # Scarb configuration
│── pnpm-lock.yaml         # Monorepo configuration
│── README.md              # This file 🚀

📖 Documentation

🔹 Frontend README: Frontend Documentation
🔹 Backend README: Backend Documentation

🌍 Connecting to StarkNet

To play, make sure you have a StarkNet-compatible wallet like ArgentX or Braavos. Game assets are backed by Cairo smart contracts, ensuring authenticity and scarcity.

🤝 Contributing

Aqua Stark is an open-source project! To contribute, follow these steps:

1️⃣ Fork the repository

git fork https://github.com/AquaStark/Aqua-Stark.git  

2️⃣ Clone your fork

git clone https://github.com/YOUR_USERNAME/Aqua-Stark.git  
cd Aqua-Stark  

3️⃣ Create a new branch

git checkout -b feature-new  

4️⃣ Make your changes and commit them

git commit -m "feat: Add new feature"  

5️⃣ Push the changes to your fork

git push origin feature-new  

6️⃣ Open a Pull Request 🚀

🔀 Branch Naming Conventions

  • feat/feature-name → For new features
  • fix/bug-name → For bug fixes
  • chore/task-name → For maintenance or refactoring
  • docs/documentation-change → For documentation updates

📝 Commit Message Guidelines

  • feat: add new login functionality
  • fix: resolve issue with fish animations
  • chore: refactor contract logic
  • docs: update README with latest changes

🌊🐠 Dive into Aqua Stark and build your dream aquarium! 🎮🚀

About

Aqua Stark's monorepo

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 83.8%
  • Cairo 13.8%
  • CSS 1.7%
  • Other 0.7%