https://github.com/darthbenro008/greencredus

A cryptocurrency that helps you save the environment!
https://github.com/darthbenro008/greencredus

blockchain cryptocurrency progressive-web-app react tezos

Last synced: about 1 year ago
JSON representation

A cryptocurrency that helps you save the environment!

Host: GitHub
URL: https://github.com/darthbenro008/greencredus
Owner: DarthBenro008
Created: 2021-02-20T09:44:46.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2021-03-10T12:02:22.000Z (over 5 years ago)
Last Synced: 2025-03-29T06:42:33.191Z (about 1 year ago)
Topics: blockchain, cryptocurrency, progressive-web-app, react, tezos
Language: JavaScript
Homepage: https://www.green-cred.us
Size: 9.73 MB
Stars: 8
Watchers: 2
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

# GreenCredUs

>The only currency that helps to save environment

![Banner](assets/banner.png)

## Aim

![Problem](assets/problem.png)

To reduce carbon emission, by integrating blockchain technology to ahieve global standard. The app works in a way that it does not add up to the carbon footprint generation and serves
the goal of users to reduce and take this initiative to reduce carbon emission.

Here are some important links:

- [Our Website](https://www.green-cred.us/)
- [Our Progressive Web App](https://app.green-cred.us/)
- [Deployed Smart Contract](https://delphinet.tezblock.io/account/KT1AQqqKu29eC7hc6Q73unXMwgLCLPdMNo9T)
- [Figma Design File](https://www.figma.com/file/JacqSsKvRUEooB28mYfNwp/KUHACK?node-id=122%3A35)

## Tools Used

![Tech Stack](assets/tech_stack.png)

- React - Used to make our website and our Progresive App.
- Tezos - Deployed Smart Contract on Tezos Network.
- Figma - Made designs and mood board.
- Smart py - Developed smart contracts for the transactions to take place.
- GoDaddy - Domain Provider.
- Firebase - For two factor OTP authentication and recaptcha.

## Getting Started

### Runnning the PWA App

- Clone the repo.
`git clone https://github.com/DarthBenro008/greencredus.git`
- Run `npm dapp-install`
- And to inititalise the PWA, run `npm start`

- For running this project successfully you'll need to create a `.env` file and store your firebase credentials there like following in the ./client folder

```env
REACT_APP_FIREBASE_API_KEY=
```

### Deploying the blockchain smart contract

- Download a Faucet Tezos Wallet from [here](https://faucet.tzalpha.net/).
- Using [ConseilJS](https://cryptonomic.github.io/ConseilJS/#/) find the helper scripts in the `utils` folder and generate a keystore
- Edit your Tezos Address in the `config.js` file.
- run the following commands:

```bash
npm run sync
npm run compile
npm run deploy
```

> Note: The given keystore is deployed on a Tezos Testnet (Delphinet) and is solely used for educational purposes only.

## Contributing

- Clone the repo.
`git clone https://github.com/DarthBenro008/greencredus.git`
- Checkout to a new branch.
`git checkout -b my-amazing-feature`
- Make some amazing changes.
- `git add .`
- `git commit -m "A short description about the feature."`
- `git push origin my-amazing-feature`
- Open a pull request :)

## Authors

_{Hemanth Krishna}
📖 💻 🚇

_{Aarush Bhat}
📖 💻 🚇

_{Harsh Singhal}
📖 💻 🚇