README.md

Pilot

The official repository for the website of PILOT
View Live

Table of Contents

1. About The Project
2. Built With
3. Getting Started
   • Prerequisites
   • Running the project
4. Features
5. Screenshots
6. Contributors

About The Project

Pilot is decentralized Web3 Blogging platform built with Lens Protocol on Polygon.

Built With

Following technologies and libraries are used for the development of this website

• React
• Lens Protocol
• Apollo
• IPFS
• Material UI
• Draft-js
• Vercel

Getting Started

To setup the project locally the steps below.

Prerequisites

• Please make sure you have metamask installed and connected to polygon's mumbai testnet and have some test matic in your wallet

• Node.js

  # Homebrew
  brew install nodejs
  
  # Sudo apt
  sudo apt install nodejs
  
  # Packman
  pacman -S nodejs
  
  # Module Install
  dnf module install nodejs:<stream> # stream is the version
  
  # Windows (chocolaty)
  cinst nodejs.install
  

• Git

  # Homebrew
  brew install git

  # Sudo apt
  apt-get install git

  # Packman
  pacman -S git

  # Module Install (Fedora)
  dnf install git

Running the project.

The project uses NPM. It is strictly advised to stick with NPM so as to avoid dependency conflicts down the line.

## Checkout into the project client directory
cd client

## Install Dependencies
npm install

## Run the Project
npm start

Following are the commands to remove/add new dependencies using yarn

## Add a new Package
npm install <package-name>

## Remove an existing Package
npm uninstall <package-name>

## Save Package as a Dev Dependency
npm install <package-name> --save-dev

Features

• Text editor using Draft-js and React
• Blogging connections (like follow) using decentralised social graph called Lens Protocol.
• Data ownership of creators on blockchain.

Screenshots

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Sambit Sankalp 💻

Sibasis-Malla 💻

This project follows the all-contributors specification. Contributions of any kind welcome!