Jump to: Getting Started · Deep Dive into Peeps · Using Peeps (No Code) · Using Peeps (Code) · What's Next
Dive into the code and live the experience with your Peeps and your Code
This tutorial assumes you have a basic knowledge of terminal use, Git and GitHub (it's not hard, don't worry). Follow the steps below to get started:
1. Clone this repository to run the Peeps source code locally on your device. Follow these instructions:
2. From your terminal, clone this repo by running git clone https://github.com/Joshaw-k/Peeps.
3. Then run cd Peeps.
4. Then run code ., this is assuming that you are using VS Code as your preferred IDE
5. Then open the terminal in your VS Code and run cd peeps_frontend. Do follow all the instructions in the frontend folder, refer to the folder's documentation for guidance.
6. After completing your frontend setup, change directory to the backend folder by running cd .. then run cd peeps_backend. Do follow all the instructions in the backend folder, refer to the folder's documentation for guidance.
7. After completing the frontend and backend setup, change directory to the custom contracts folder by running cd .. then run cd deploy-custom-contracts. Do follow all the instructions in the custom contracts folder, refer to the folder's documentation for guidance.
8. After completing all the setup, Peeps is available for use locally.
Please let us know your feedback by raising an issue on the repo on github or sending an email to the development team here.
Frontend: The entire frontend is developed with React. All assets, including fonts, images, and sprites for animations, are sourced from the internet.
Backend: The backend is developed using Javascript and runs inside the Cartesi machine.
Identity Security: The Peeps platform uses zkPass zk-KYC for identity verification.
Smart Contracts: The Peeps token smart contract is written in Solidity.
Frontend-Backend Interaction: The front end interacts with the backend using Sunodo.