blockipedia-near's Introduction

Blockipedia-NEAR

A wikipedia on NEAR Protocol

Visit the Blockipedia page

https://nlhkh.github.io/blockipedia-near/

How to develop locally

Backend (smart contract on NEAR rust sdk)

Prerequisites:

make build
make dev-deploy

Frontend (Gatsby React app)

Prerequisites:

Node.js
yarn

All frontend resources are under ./frontend directory For local development, Gatsby expects env vars from the .env.development file Feel free to copy from .env.development.sample and make any change you need

make dev-frontend

How to run tests

Run tests against the entire suite

make test

Run test for a single unit test

make test TEST_TARGET=test_name
# where `test_name` is the name of the specific test function
# e.g. "create_article_with_insufficient_fund"

Run tests while allowing console log messages (e.g. from `println!` or `dbg!`) to show up

# run all tests
make test-verbose
# run a specific test
make test-verbose TEST_TARGET=test_name

blockipedia-near's People

Contributors

Stargazers

Watchers

blockipedia-near's Issues

Redirect to read page after creating article

Voting for articles (backend)

Make use of NEAR indexer framework if/where necessary

In line with the initiative of caching certain data in a separate db so that we don't have to directly query on-chain data every time, there's the official NEAR indexer framework that might help as a starting point: https://github.com/near/near-indexer-for-explorer#shared-public-access

Let's see if we can make use of this framework at all, or not.

Setup nuxt 2

Improve Rust code quality with Clippy

Use Clippy to lint Rust code.

Voting for articles (frontend)

Switch to SimulationTest

Afaik, NEAR is recommending Simulation Tests over mock tests. We probably wanna explore & implement Simulation Tests at some point?

Donate to article (backend)

prevent the same person from upvoting or downvoting the same article more than once

Donate to article (frontend)

@Thesephi The NEAR wallet api (client-side) let users send tokens directly to another token, so perhaps we don't need to implement donation on the contract.

Discuss & implement the logic to split donation amt between article Author and Contributors

This issue is a follow-up to #10 . More context in this comment: #10 (comment)

Charge for creating an article

Compose interface with Markdown

Use ReactMarkdown with remark gfm
Write mode /write
Edit mode /write/<article_id>

Charge for updating an article

Start link

Should:

Sign-in if not authenticated
Go to write new article page if authenticated

Read interface

Render markdown for an article

Remove .env.* files from git (as per best practices)

Maybe we can follow the practice as recommended and remove these files from git? We can probably keep a .env.template file to track the fields (without the values) so everyone knows what fields are expected?

Fix code scanning alert - unneeded return statement

Tracking issue for:

https://github.com/nlhkh/blockipedia-near/security/code-scanning/11

Create Blockipedia Logo

Propose 1

Add landing page

If authenticated: show a list of articles
If not authenticated: show a sign-in button

Create Markdown Component

Call contract to upvote/downvote articles (frontend)

Deploy contract to Testnet

This should be done once we are satisfied with the contract data model.

Edit articles (frontend)

route /write/<id>

Show article author, and editors

Remove article when downvote too much

If upvote/downvote ratio is 3:7, then article will be removed

Compose our story

Blockipedia is a Wikipedia living on the NEAR blockchain.

With Blockipedia, we aim to give credits to the authors and contributors of wiki articles. Readers can optionally donate to an article, and the tokens shall be distributed to the author and contributors according to a predefined ratio.

This is also an opportunity for us to learn about building application on blockchain in general.

In the future, we intend to:

Utilize regular database to assist with storing large amount of data, in addition to the NEAR blockchain storage.
Index the articles for full-text searching.
Use regular social authentication to allow non-NEAR users to read articles.

Create frontend

Setup Gatsby
Setup NEAR client sdk
Link NEAR wallet
Deploy to GitHub Page

Recommend Projects

nlhkh / blockipedia-near Goto Github PK