Welcome!
This repository contains the files relating to SafeBay. SafeBay, when completed, will offer a final and near failsafe layer of safety and opportunity for wallet recovery due to loss of seed recovery phrases often required in the decentralized finance space. Our motivation for building out this project stems from the projected figures of value lost in cryptocurrency due to lost seed phrases.
For presentation, click here
Technologies
Programming Languages: Python 3.7.10 and Solidity
Development Environments: Ganache and VSCode.
See 'Final_Requirements.txt' folder for all of the project's required libraries.
Installation Guide
Primary SafeBay Site for main site, click here
- Clone the repository
- Open up your python CLI and create a new environment with the following command: 'conda create -n python=3.7 anaconda -y'.
- Navigate to the 'SafeBayProject' folder and activate the newly created environment if you have not already.
- Navigate to the 'fully_integrated_app' folder and run the following command to download all of the projects requirements. 'pip install -r Final_Requirements.txt'
- With all of the requirements installed, you can launch our site locally with the following command: 'python run.py'
- With the site up, users can begin the registration process by inputting some basic information.
- After registration is complete, new users can sign in to view our whitepaper, token allocation plans, and more.
- Users also have the option to register their face and use that to log in to our site.
- See "Webpage Display and Usage" for a site walk-through.
SafeBay Whitelisting dApp for our whitelist, click here
- Navigate to the "ICO-whitelisting_dapp" folder then into the "SafeBay_whitelisting" folder and finally into the "ethereum=SafeBay-asset-tokenization" folder.
- Ensure that nodejs, solidity compiler, and truffle are installed per the requirements folder.
- Navigate to the root directory and run 'npm install', then navigate to the client folder and run 'npm install'
- Open up Ganache and set up a quick ethereum blockchain and update the 'truffle-config' file with the network parameter if necessary.
- Compile and migrate smart contracts to the local blockchain with the following code (from truffle console): 'truffle migrate --network "development/ganache-local" --reset'.
- Start the react app by navigating into the client folder and running the command 'npm start'.
- If you would like to test the smart contracts, navigate back to the root directory and run the command: 'truffle test'.
Webpage Display and Usage
Whitepaper and Tokenomics Section
With FaceID successfully set up, users can add and view their private information. Do not input private information yet, still in development.
The webstyling for our site was developed in VSCode using HTML, CSS, Bootstrap 5, and part of the color scheme and code for Safia, a free responsive 5 HTML5 multipurpose landing page. All photo stock used at the website came from Adobe Stock. The presentation was built in Canva using Canva and Adobe stock images. Our logo was designed in Canva.
Contributors
Project Manager/Founder: Ray Hurst
Backend/Frontend Developer: Michael Bejan
Solidity/Tokenomics Developer: Leo Harada
Front End Manager/Brand Ambassador: Tonia Hurst
Head of Research/Solidity Developer: Nathan Duft
License
Private project, no license for public use.