Giter VIP home page Giter VIP logo

Pesabooks: Collaborative Crypto Investing Made Easy

Description

Pesabooks leverages the power of decentralized technology and multi-sig wallets to provide a secure, transparent and convenient platform that allows a group of people to save and invest together in the cryptocurrency market. With Pesabooks, users can pool their funds and invest in a variety of cryptocurrencies and decentralized finance (DeFi) assets.

Installation

Prerequisite

Before starting the installation process, there are a few tools and accounts that you will need:

  1. A Supabase account: You will need a Supabase account to utilize the Supabase service. Supabase is an open-source platform that provides a set of tools and services for building and scaling applications with PostgreSQL databases. It offers features such as real-time data synchronization, authentication, and authorization. To create a Supabase account, visit their website (https://supabase.io/) and sign up for an account if you haven't already done so.

note: It is possible to run a Supabase local instance without but I haven't tried yet and cannot provide instructions at this time

  1. Infura account: In order to interact with the Ethereum blockchain, you will need an Infura account. Infura is a popular infrastructure provider that offers access to Ethereum's network via APIs. It allows you to read data from the blockchain, send transactions, and interact with smart contracts. To create an Infura account, go to the Infura website (https://infura.io/) and sign up for a free account.
  2. Web3Auth account: Web3Auth is a non-custodial auth infrastructure for Web3 apps and wallets that enables seamless user logins to both mainstream and native Web3 users. Visit the Web3auth website (https://web3auth.io/) and sign up for an account.

Deploy Supabase project

  1. Deploy database changes and functions
# Link your project
supabase link --project-ref <project-id>

# Deploy database changes
supabase db push

# Deploy Edge Functions
supabase functions deploy balances
supabase functions deploy get-access-token --no-verify-jwt
supabase functions deploy ramp-callback --no-verify-jwt
supabase functions deploy send-invitation
supabase functions deploy send-notification
  1. Configure remote secrets

Create a ./supabase/.env file for storing your secrets. use the .env.example file as a reference

# Push all the secrets from the .env file to our remote project
supabase secrets set --env-file ./supabase/.env

Deploy the app

  1. Navigate into the project directory:
cd app
  1. Install dependencies:
yarn
  1. Create a .env file with environment variables

You can use the .env.example file as a reference. Here's the list of all the required and optional variables:

Env variable Description
REACT_APP_ENV required Environment. Default development
REACT_APP_SUPABASE_PROJECT_ID required Supabase project id
REACT_APP_SUPABASE_ANON_KEY required Supabase anon key
REACT_APP_INFURA_KEY required Infura RPC API token
REACT_APP_INCLUDE_TESTNETS optional Include or not the tesnets (Goerli)
REACT_APP_WEB3AUTH_NETWORk required Web3Auth network: testnets or cyan
REACT_APP_WEB3AUTH_CLIENT_ID required Web3Auth client id
REACT_APP_RAMP_API_KEY optional Ramp host api key for Fiat onrampCollB
REACT_APP_SENTRY_DSN optional Sentry id for tracking runtime errors
REACT_APP_WALLET_CONNECT_PROJECT_ID optional WalletConnect project id
  1. Start the development server:
yarn start

Your app should now be running on http://localhost:3000.

Usage

The detailed documentation for this application is available at our documentation site. This includes step-by-step guides on how to use the application, tips and tricks, troubleshooting information, and more. Please refer to the documentation for the most comprehensive and up-to-date information.

Remember, the documentation is a great place to start if you're new to this application!

Contributing

We love contributions! Please see our Contributing guide for more details.

Licence

This project is licensed under the terms of the GNU General Public License v3.0.

Pesabooks's Projects

Pesabooks doesnโ€™t have any public repositories yet.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.