MSBivens / community-funding

MIT License
1 stars 1 forks source link

Contributors Forks Issues MIT License


Logo

Community Funding

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

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

About The Project

Product Name Screen Shot

This project is an MVP being built for the Polygon BUIDL It 2022 hackathon. This project makes use of the ERC1155 token standard and allows users to mint several tokens with a single contract that act as a fundraising mechanism for various projects similarly to the Kickstarter website.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you can set up your project locally. To get a local copy up and running follow these simple example steps.

Installation

  1. Clone the repo
    git clone https://github.com/msbivens/community-funding.git
  2. Install NPM packages
    npm install
  3. Enter your API in a .env
    API_KEY = 'YOUR API KEY';

(back to top)

Usage

This section provides some brief examples of how to use the project. Larger documentation may be produced following the hackathon if the project persists.

(back to top)

Roadmap

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

Future Features Under Consideration

(back to top)

Contributing

Contributions are always welcome. Take a look at the "issues" tab to see current efforts or 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

(back to top)

License

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

(back to top)

Top Contributors

Mike Bivens | Twitter | Website

(back to top)

Acknowledgments

(back to top)