Skip to content

Latest commit

 

History

History
272 lines (196 loc) · 9.61 KB

Readme.md

File metadata and controls

272 lines (196 loc) · 9.61 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Wake UP Contract

An awesome Solidity smart contract to force yourself to wake up!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. ChangeLog
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgments

About The Project


.
.

This is a project regarding a SmartContract and a Front End web GUI to use as a bet against onself to be able to wake up early in the morning. It is going to be the most used motivational and self improvement SmartContract for waking up early used by the masses of new modern human beings born in the web3 golden era of the future.

Here's why:

  • Your time is the most important thing in your life. You cannot buy time.
  • You shouldn't be waking up late and be a lazy hooman. You'v got to have your S. together and wake up early to do lots of stuff.
  • Using a Smart Contract to help you with this is pure fun.

This project is in an early stage. Be very careful if you use this code for any purposes, I advise against it.

(back to top)

Built With

Built with these frameworks/libraries, add-ons/plugins will be added later

  • React
  • Solidity

(back to top)

Getting Started

Instructions will come when Testnet v1.0 is ready.

Prerequisites

There will be a list of things you need to use this amazing Smart Contract.

  • npm

    npm nothing here yet

Installation

Example on how to install/use will come in the future...

  1. Goto https://github.com/JPLACLAU/WakeUpContract

  2. Clone the repo

    git clone https://github.com/JPLACLAU/WakeUpContract
  3. Coming soon...

    Coming soon...

(back to top)

Usage

You should not use this app at this moment.

For more examples, please refer to the Documentation

(back to top)

Features Roadmap

  • Start the proyect
  • Single person usage with no check on wake up time. "Trust the user"
  • Single person usage with a check time.
  • Add additional stuff
  • Make the front-end beautiful.
  • Multi-language Support
    • French
    • Spanish
  • Add moar stuff

See the open issues for a full list of proposed features (and known issues).

(back to top)

ChangeLog & Versions Roadmap

Current version: 0.4.1

Version Changes
0.6 Unit tests and gas improvements.
0.5.1 Nicer Front End built with React.
0.5.0 Basic HML Front End.
0.4.2 Unit tests and gas improvements. (Failed attempt)
0.4.1 Removing non essential functions. Use https://www.unixtimestamp.com to get Unix timestamps.
0.4 Working on adding a chainlink oracle time functions to setup the hour of withdrawal (wake up hour).
0.3.1 Hybrid real time + manually time functions (all works)
0.3 Only withdraw at the desired hour
0.2.1 Contract is only owner "ownable" can set the hour, receive and retrieve funds in eth.
0.1 Start the proyect /write the Readme.md

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request
Help is needed!
- At this moment, I could use the help of someone with JS experience to help me work one some time functions on the client's side. contact me for more info.-

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Jean-Paul Laclau - @jplaclau -

Project Link: https://github.com/JPLACLAU/WakeUpContract

(back to top)

Acknowledgments

Thank you so much to.. no one yet! Be the first to collab!

(back to top)

Disclaimer

Check the LICENSE.txt