Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dabit3/lens-protocol-frontend

Example of a basic front end built on Lens Protocol
https://github.com/dabit3/lens-protocol-frontend

Last synced: 3 months ago
JSON representation

Example of a basic front end built on Lens Protocol

Awesome Lists containing this project

README

        

# Lens Protocol Front End Starter

This is an example of how to build a front-end application on top of [Lens Protocol](https://docs.lens.xyz/docs).

The main API calls used in this app are defined in __api/index.js__:

1. [recommendProfiles](https://docs.lens.xyz/docs/recommended-profiles#api-details) - Get popular profiles

2. [getProfiles](https://docs.lens.xyz/docs/get-profiles) - Get profiles by passing in an array of `profileIds`

3. [getPublications](https://docs.lens.xyz/docs/get-publications) - Returns a list of publications based on your request query

4. [searchProfiles](https://docs.lens.xyz/docs/search-profiles-and-publications) - Allows a user to search across hashtags on publications or profile handles. This query returns either a Post and Comment or Profile.

5. [follow](https://docs.lens.xyz/docs/functions#follow) - Follow a user

6. [burn](https://docs.lens.xyz/docs/functions#burn) - Unfollows a user

7. [timeline](https://docs.lens.xyz/docs/user-timeline) - Shows a feed of content tailored to a signed in user

8. [createSetProfileMetadataTypedData](https://docs.lens.xyz/docs/create-set-update-profile-metadata-typed-data) - Allows a user to update the metadata URI for their profile

9. [post](https://docs.lens.xyz/docs/functions#post) - Allows a user to publish content

You can view all of the APIs [here](https://docs.lens.xyz/docs/introduction) and contract methods [here](https://docs.lens.xyz/docs/functions)

## Running this project

> For this project to run, you must configure the **Infura project ID and project secret** in a file named `.env.local`. Check out .example.env.local for guidance.

You can run this project by following these steps:

1. Clone the repo, change into the directory, and install the dependencies

```sh
git clone [email protected]:dabit3/lens-protocol-frontend.git

cd lens-protocol-frontend

npm install

# or

yarn
```

2. Run the project

```sh
npm run dev
```

3. Open the project in your browser at [localhost:3000](http://localhost:3000/)