-
-
Notifications
You must be signed in to change notification settings - Fork 24
Improve README following Hammer Auction House style (#47) #65
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
Open
ankitrraj
wants to merge
2
commits into
StabilityNexus:main
Choose a base branch
from
ankitrraj:improve-readme-47
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,108 @@ | ||
| This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). | ||
| <div align="center"> | ||
|
|
||
| <img src="https://raw.githubusercontent.com/StabilityNexus/HammerAuctionHouse-WebUI/main/public/stability.svg" alt="Stability Nexus Logo" width="200"/> | ||
| <img src="https://evm.hodlcoin.co.in/hodlcoin.svg" alt="hodlCoin Logo" width="200"/> | ||
|
|
||
|   | ||
|
|
||
| [](https://t.me/StabilityNexus) [](https://x.com/StabilityNexus) [](https://discord.com/invite/YzDKeEfWtS) [](https://news.stability.nexus/?gi=b27790163ddc) [](https://www.linkedin.com/company/stability-nexus/) [](https://www.youtube.com/@StabilityNexus) | ||
|
|
||
| </div> | ||
|
|
||
| --- | ||
|
|
||
| ## hodlCoin Staking Platform | ||
|
|
||
| [hodlCoin Solidity WebUI](https://evm.hodlcoin.co.in/) is a decentralized staking platform that provides a seamless interface for interacting with hodlCoin smart contracts on blockchain. Supporting self-stabilizing staking vaults where the price is mathematically proven to always increase through smart contracts, it provides a secure and transparent environment for staking digital assets. | ||
|
|
||
| The platform is powered by smart contracts that implement: | ||
|
|
||
| - **Multiple Vault Types**: Create and manage various types of staking vaults with different parameters and reward mechanisms | ||
| - **Smart Contract Security**: Trustless execution with on-chain validation and verifiable, immutable transactions | ||
| - **Token Staking**: Stake hodlCoin tokens and earn rewards based on vault performance | ||
| - **Wallet Integration**: Seamless MetaMask and Web3 wallet support | ||
| - **Transparent History**: Fully on-chain transaction records and staking history | ||
| - **Extensible Services**: Modular vault services interface to support future staking mechanisms | ||
|
|
||
| --- | ||
|
|
||
| ## Tech Stack | ||
|
|
||
| ### Frontend | ||
|
|
||
| - Next.js 14+ (React) | ||
| - TypeScript | ||
| - TailwindCSS | ||
| - shadcn/ui | ||
|
|
||
| ### Blockchain | ||
|
|
||
| - Wagmi | ||
| - Solidity Smart Contracts | ||
| - Ethers.js | ||
| - Rainbow-Kit Wallet Integration | ||
|
|
||
| --- | ||
|
|
||
| ## Getting Started | ||
|
|
||
| First, run the development server: | ||
| ### Prerequisites | ||
|
|
||
| - Node.js 18+ | ||
| - npm/yarn/pnpm | ||
| - MetaMask or any other web3 wallet browser extension | ||
|
|
||
| ### Installation | ||
|
|
||
| #### 1. Clone the Repository | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| git clone https://github.com/StabilityNexus/hodlCoin-Solidity-WebUI.git | ||
| cd hodlCoin-Solidity-WebUI | ||
| ``` | ||
|
|
||
| #### 2. Install Dependencies | ||
|
|
||
| Using your preferred package manager: | ||
|
|
||
| ```bash | ||
| npm install | ||
| # or | ||
| yarn dev | ||
| yarn install | ||
| # or | ||
| pnpm dev | ||
| # or | ||
| bun dev | ||
| pnpm install | ||
| ``` | ||
|
|
||
| Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
| #### 3. Run the Development Server | ||
|
|
||
| You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. | ||
| Start the app locally: | ||
|
|
||
| This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. | ||
| ```bash | ||
| npm run dev | ||
| # or | ||
| yarn dev | ||
| # or | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| ## Local Setup with Project ID | ||
| #### 4. Open your Browser | ||
|
|
||
| Before running the project locally, you need to set up an environment variable with your Project ID. Follow these steps: | ||
| Navigate to [http://localhost:3000](http://localhost:3000) to see the application. | ||
|
|
||
| 1. **Create a `.env` File** | ||
| In the root directory of the project, create a file named `.env` and add the following line: | ||
| ```env | ||
| NEXT_PUBLIC_PROJECT_ID=your-project-id | ||
| ``` | ||
| --- | ||
|
|
||
| 2. **Obtain Your Project ID** | ||
| To get your `your-project-id` value: | ||
| - Visit [Reown Cloud](https://cloud.reown.com/sign-in). | ||
| - Create an account or log in if you already have one. | ||
| - Create a new project within the dashboard. | ||
| - Once the project is created, locate your project key (this may be labeled as "Project ID" or "API Key"). | ||
| - Copy the key and paste it into your `.env` file in place of `your-project-id`. | ||
| ## Contributing | ||
|
|
||
| After setting up the environment variable, you can run the development server as described above. | ||
| We welcome contributions of all kinds! To contribute: | ||
|
|
||
| ## Learn More | ||
| 1. Fork the repository and create your feature branch (`git checkout -b feature/AmazingFeature`). | ||
| 2. Commit your changes (`git commit -m 'Add some AmazingFeature'`). | ||
| 3. Push your branch (`git push origin feature/AmazingFeature`). | ||
| 4. Open a Pull Request for review. | ||
|
|
||
| To learn more about Next.js, take a look at the following resources: | ||
| If you encounter bugs, need help, or have feature requests: | ||
|
|
||
| - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. | ||
| - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. | ||
| - Please open an issue in this repository providing detailed information. | ||
| - Describe the problem clearly and include any relevant logs or screenshots. | ||
|
|
||
coderabbitai[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| We appreciate your feedback and contributions! | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
head -20 README.md | cat -nRepository: StabilityNexus/hodlCoin-Solidity-WebUI
Length of output: 2123
🏁 Script executed:
Repository: StabilityNexus/hodlCoin-Solidity-WebUI
Length of output: 486
Verify external image URLs are accessible; some social media links may have access restrictions.
The README references external image URLs that are accessible and working correctly. However, some social media links return access restriction codes (HTTP 403/999) when accessed programmatically, though these may be due to anti-bot protection on those platforms rather than actual broken links:
Consider manually testing these social media links in a browser to confirm they lead to the correct accounts, or consider using services that specifically test social media profile URLs.
Also applies to: 8-8