Skip to content

Commit

Permalink
Add some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ifavo committed Jan 23, 2025
1 parent 302f270 commit e6e9af3
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 favo

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# VeBetterDAO Vote Tracker

This project is an example application tracking allocation votes for users on the VeBetterDAO. It highlights a single app and includes votes cast directly and those made using a veDelegate.vet staking wallet.

## Deployment

The application is deployed on GitHub Pages and can be accessed at the following link:

[VeBetterDAO Vote Tracker Deployment](https://vechain-energy.github.io/example-vebetterdao-vote-tracker/)

## Features

- Track voting behavior for a specific user.
- Highlight a single app.
- Includes votes cast directly and via veDelegate staking wallet.

## Getting Started

To run this project locally, follow these steps:

1. Clone the repository:
```bash
git clone https://github.com/your-username/example-vebetterdao-vote-tracker.git
```

2. Navigate to the project directory:
```bash
cd example-vebetterdao-vote-tracker
```

3. Install dependencies:
```bash
npm install
```

4. Start the development server:
```bash
npm run dev
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License.

0 comments on commit e6e9af3

Please sign in to comment.