Follow these steps to clone and run the project using Visual Studio Code.
- Node.js (Version 18.x or higher)
- npm (Version 9.x or higher)
- Visual Studio Code
- Git
# Clone repository
git clone https://github.com/Huc06/Sharkbling
# Navigate to project directory
cd Sharkbling# Install project dependencies
npm installCreate a .env file in the project root:
# Create .env from template
cp .env.example .envOpen .env and configure required variables:
# Sui environment (testnet, devnet, or mainnet)
SUI_NETWORK=testnet
# Deployed package ID on Sui
SUI_PACKAGE_ID=your_package_id
### 4. Run Development Environment
```bash
# Start development server
npm run dev
The application will launch at http://localhost:5173/.
For the best development experience, install these VS Code extensions:
- ESLint
- Prettier
- TypeScript Vue Plugin (Volar)
- Tailwind CSS IntelliSense
Create VS Code settings (.vscode/settings.json):
{
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
"typescript.tsdk": "node_modules/typescript/lib",
"typescript.enablePromptUseWorkspaceTsdk": true
}The project follows this organization:
SharkBling/
├── client/ # Frontend code
│ ├── src/ # Frontend source code
│ │ ├── components/ # React components
│ │ ├── contexts/ # Context providers
│ │ ├── hooks/ # Custom React hooks
│ │ ├── lib/ # Libraries and utilities
│ │ ├── pages/ # Application pages
│ │ ├── App.tsx # Main application component
│ │ └── main.tsx # Entry point
│ └── index.html # HTML template
|
├── .env # Environment variables
├── .env.example # Environment variables template
├── package.json # Dependencies and scripts
├── tsconfig.json # TypeScript configuration
└── vite.config.ts # Vite configuration
To deploy Move smart contracts on Sui network:
- Install Sui CLI:
cargo install --locked --git https://github.com/MystenLabs/sui.git --branch devnet sui- Navigate to smart contract directory:
cd SmartContract/move- Compile and export package:
sui move build- Deploy to Sui Testnet:
sui client publish --gas-budget 200000000- Update package ID in your
.envfile.
- Create new branch from
mainfor new features - Follow commit convention:
feat: descriptionorfix: description - Create Pull Request to merge into
mainbranch
If you encounter any issues during setup or operation, please create an issue on the GitHub repository or contact the development team.