https://github.com/m-azra3l/simple-vest

https://github.com/m-azra3l/simple-vest

Last synced: 25 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/m-azra3l/simple-vest
• Owner: m-azra3l
• License: mit
• Created: 2023-06-26T19:44:19.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-06T12:54:53.000Z (over 1 year ago)
• Last Synced: 2024-11-08T23:33:02.437Z (3 months ago)
• Language: JavaScript
• Homepage: https://neo-vest.vercel.app
• Size: 1.12 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NEO-VEST

This smart contract provides a functionality for organizations to establish a vesting schedule for their tokens. It allows organizations to register themselves, define the stakeholders involved and their respective vesting periods. The contract also enables the whitelisting of addresses and facilitates the claiming of tokens once the vesting period has elapsed.

## Getting Started

Download the codes by downloading the entire repository, in the project directory,  run the following command to install the dependencies:

```shell

 yarn install

```

To deploy the contract, setup your `.env` file by renaming the `.env.example` file to `.env`, paste your wallet private key where necessary and run the following command:

```shell

yarn hardhat run scripts/deploy.js --network mumbai

```

To start the project, run the following command:

```shell

yarn run dev

```

To test the smart contract, run the following command:

```shell

yarn hardhat test 

```

## Author

[Michael](https://github.com/m-azra3l)

## License

This project is licensed under the [MIT License](LICENSE).

## Disclaimer

This project is but an example project, it is not for the purpose of commercial use.