open-blockchain-explorer / tnbexplorer

Blockchain Explorer for thenewboston cryptocurrency network

4 stars 4 forks source link

Documentation #61

Open itsnikhil opened 2 years ago

itsnikhil commented 2 years ago

Follow the guide https://opensource.guide/starting-a-project/#launching-your-own-open-source-project

TODO:

README
Quick Start guides
Contributing guidelines
Code of conduct

itsnikhil commented 2 years ago

@tomijaga please you update readme for website with all the instructions, how people can build website in their local environment and hopefully be able to contribute in some ways.

LuluNwenyi commented 2 years ago

Hi @itsnikhil, does this issue still need help? I'd like to work on the contributing.md

LuluNwenyi commented 2 years ago

Hi @itsnikhil, does this issue still need help? I'd like to work on the contributing.md

LuluNwenyi commented 2 years ago

And code of conduct if that's cool

itsnikhil commented 2 years ago

@LuluNwenyi sure go ahead I am assigning it to you 👍

LuluNwenyi commented 2 years ago

Hi @itsnikhil, Could you give me an overview of the project and this repo so I can make the README.md better? I'd like to link it to the CONTRIBUTING.md file.

itsnikhil commented 2 years ago

@LuluNwenyi please join our discord server. We can schedule a call and I will explain you everything there https://discord.gg/sf8HWJPE

LuluNwenyi commented 2 years ago

Alright

tomijaga commented 2 years ago

@LuluNwenyi Hey I did some work on the readme. Maybe you can take a look at it and add a few updates to it. When you are done with the readme and code of conduct you can submit a pull request so I can merge to the master branch.

tomijaga commented 2 years ago

Project Title

TnbExplorer is a website tool for exploring and inspecting thenewboston blockchain for transactions, nodes, addresses and other analytics data on thenewboston.

Features

Address Lookup
Richlist
Curated Analytics page
Payments Processing and Requests
Multiple network integration (Mainnet and Testnet)
Testnet Faucet

Getting started

Instructions get a copy this project and run on your local machine for development and testing.

Installation

Clone the project using git from the terminal

    git clone https://github.com/open-blockchain-explorer/Website

Go to the project directory

    cd tnbexplorer

Install the project's dependencies

    npm install

Run the project on your computer
```
npm start
```

License

MIT

LuluNwenyi commented 2 years ago

@tomijaga has a readme been created or would you like me to use these details to create one??

tomijaga commented 2 years ago

@LuluNwenyi the readme hasn't been created yet. I sent this so you can add it to the one you are about to create.

LuluNwenyi commented 2 years ago

Okay. I've don't that and I've opened PR #76 for this issue