Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #61

Open
itsnikhil opened this issue Oct 1, 2021 · 13 comments
Open

Documentation #61

itsnikhil opened this issue Oct 1, 2021 · 13 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@itsnikhil
Copy link
Contributor

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
Copy link
Contributor Author

itsnikhil commented Oct 1, 2021

@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.

@itsnikhil itsnikhil added the documentation Improvements or additions to documentation label Oct 1, 2021
@LuluNwenyi
Copy link
Contributor

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

1 similar comment
@LuluNwenyi
Copy link
Contributor

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

@LuluNwenyi
Copy link
Contributor

And code of conduct if that's cool

@itsnikhil
Copy link
Contributor Author

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

@itsnikhil itsnikhil assigned LuluNwenyi and unassigned itsnikhil and tomijaga Oct 4, 2021
@LuluNwenyi
Copy link
Contributor

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
Copy link
Contributor Author

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

@LuluNwenyi
Copy link
Contributor

Alright

@tomijaga
Copy link
Collaborator

tomijaga commented Oct 5, 2021

@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
Copy link
Collaborator

tomijaga commented Oct 5, 2021

Project Title

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

Features

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
Copy link
Contributor

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

@tomijaga
Copy link
Collaborator

tomijaga commented Oct 6, 2021

@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
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants