An open API service indexing awesome lists of open source software.

https://github.com/simcoderyoutube/mycryptolink


https://github.com/simcoderyoutube/mycryptolink

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

![Version](https://img.shields.io/badge/version-0.1-blue.svg?cacheSeconds=2592000)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![image](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/simcoder_here)
[![image](https://img.shields.io/badge/Instagram-E4405F?style=for-the-badge&logo=instagram&logoColor=white)](https://www.instagram.com/simcoder_here/)
[![image](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/channel/UCQ5xY26cw5Noh6poIE-VBog)





Logo

MyCryptoLink


A web application to share your wallets easily with just one link


Explore the docs »




View Working website
·
Report Bug
·
Request Feature

Table of Contents




  1. About The Project



  2. Getting Started


  3. Roadmap

  4. Contributing

  5. Support

  6. License

  7. Contact

## About The Project

![alt text](images/preview.png "Title")

This project is similar to [LinkTree](https://linktr.ee/) and aims to allow anyone to easily share their crypto wallet addresses with anyone with just one easy link.

It is specifically important for anyone with an online presence that wants to receive donations as it offers a clean way of giving this donation option without the need to typing an address each and every single time someone asks for it.

### Built With

* [ReactJs](https://reactjs.org/)
* [Firebase](https://firebase.google.com/)

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.
* npm
```sh
npm install npm@latest -g
```

### 💻 Installation

1. Clone the repo
```sh
git clone https://github.com/SimCoderYoutube/MyCryptoLink.git
```
1. Install NPM packages
```sh
npm install
```

1. Firebase
1. Create a Firebase project
1. Start Realtime database (it won't get used but it needs to be initialized)
1. Enable Firestore and paste the firestore_rules.txt into the rules tab
1. Go to authentication and enable google sign in
1. Go to project settings and add a web app
1. Copy the firebaseConfig and paste it into ``frontend/src/App.js`` replacing the current firebaseConfig
1. Deploy the firebase function with the in backend/index.js file

1. Run
```sh
npm start
```

## Roadmap

See the [open issues](https://github.com/SimCoderYoutube/MyCryptoLink/issues) for a list of proposed features (and known issues).

## ➕ Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Please check the [Wiki](https://github.com/SimCoderYoutube/MyCryptoLink/wiki/How-to-Contribute)

## 🌟 Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2021 [SimCoder](https://github.com/simcoderYoutube).

This project is [GPL 3](https://github.com/SimCoderYoutube/MyCryptoLink/blob/main/LICENSE) licensed. Some of the dependencies are licensed differently.

## 👤 Contact

**SimCoder**

* Website: www.simcoder.com
* Twitter: [@simcoder\_here](https://twitter.com/simcoder\_here)
* Github: [@simcoderYoutube](https://github.com/simcoderYoutube)
* Youtube: [SimCoder](https://www.youtube.com/channel/UCQ5xY26cw5Noh6poIE-VBog)