Skip to content

Latest commit

 

History

History
265 lines (189 loc) · 9.11 KB

Readme.md

File metadata and controls

265 lines (189 loc) · 9.11 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Bar tips smart-contract

An awesome Solidity smart contract to fill the bar-tipping jar of a group of waiters & bartenders
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 to use among friends when going to a bar to leave a collaborative tip to the staff of the venue. This project is in an early stage. Be very careful if you use this code for any purposes, I advise against it.

Here's why a group of waiters and bartenders should use it in their bar:

  • Fair tipping is complicated
  • Not everyone really shares
  • As it is open in a public ledger, there is no room for mistrusting amongs collegues.

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/Hunger-Games

  2. Clone the repo

    git clone https://github.com/JPLACLAU/Hunger-Games

  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
  • First version of the smart contract is ready with basic functionality
  • Add additional stuff
  • Make the front-end beautiful.
  • 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.2.1

Version Changes
0.2.2 Some checks added
0.2.1 corrections done... + Empty the Jar function added and working.
0.2.0 Adding withdraw and send tips
0.1.1 Bartenders can register to the list of working people on the bar.
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 do not require help, I might ask for it in the future.-

(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/Hunger-Games

(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