Skip to content

Latest commit

 

History

History
149 lines (105 loc) · 4.65 KB

README.md

File metadata and controls

149 lines (105 loc) · 4.65 KB
Raw

Version License: GPL v3 image image image


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

This project is similar to LinkTree 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

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 
    npm install npm@latest -g

💻 Installation

  1. Clone the repo

    git clone https://github.com/SimCoderYoutube/MyCryptoLink.git

  2. Install NPM packages

    npm install

  3. Firebase

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

  4. Run

    npm start

Roadmap

See the open 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

🌟 Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2021 SimCoder.

This project is GPL 3 licensed. Some of the dependencies are licensed differently.

👤 Contact

SimCoder