Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
185 lines (156 sloc) 7.53 KB
layout title title_text author date sections page_type github_file
guides
NavHub Guides - Projects
Projects
Craig MacGregor
2018-05-30T17:44:23+12:00
Overview
Ways you can help existing projects
Create new Development project on NavHub
guide
content/guides/projects/_index.md

NavCoin Development Projects

Overview

{{< text_block title="Development is important for NavCoin ecosystem to self-sustain and grow" >}} Developers are a core part of the NavCoin community - we’re always looking for more people to help build new projects, and contribute to the wider NavCoin ecosystem. Whatever your skill set or experience, there are a range of projects you can help with. From fixing bugs, testing new releases, to creating your own project that uses NAV. In NavCoin, everyone gets decides what they work on.

{{< /text_block >}}

{{< text_block title="Community fund helps you build projects" >}} The NavCoin community fund can help you get paid for your contributions. All you need to do is submit a proposal, and the community votes on whether they think it adds to the NavCoin ecosystem. There is 500,000 NAV available in the fund each year for proposals, and it’s open to anyone. {{< /text_block >}}

{{< text_block title="Benefits for developers" >}} If you’re looking to get involved with crypto, this is the perfect opportunity for you. There are a range of ways to contribute, and you’ll be surrounded by a passionate community of developers who you can reach out to for help. Not only will you be learning new skills, but you’ll also gain a reputation among the community as someone who’s keen to help out. {{< /text_block >}}

{{< divider >}}

{{< quote image="/images/guides/projects/matt.jpeg" text="Fund yearly/bi-yearly server costs for sites like the block explorer (any smaller period than that is probably too short for voting to pass). It can help fund people to create new tools/sites/walls or improve existing ones. New paper wallet anyone?" author="Matt" link_href="" link_text=""

}}

Ways you can help existing projects

{{< info_tiles category="projects" >}}

Create new Development project on NavHub

{{< text_block title="Step 1: Getting things ready" >}}

  1. Sign in to our GitHub account, if you don't have one, sign up here.

  2. Then go to the navhub repo

  3. Type your project name in the first text field. (For example : my-awesome-project)

  4. Then hit / on your keyboard, an empty input field will appear.

  5. Type index.md in the new input field.

make



Now we have created an empty Markdown file for your project card. (If you haven't heard of Markdown, you can think of it as a normal plain text file with additional web features.) Next we'll learn how to add content to it. {{< /text_block >}}

{{< text_block title="Step 2: Fill out the markdown template" >}}
Copy the template below to the index.md you just created. If you want to customize the background icon for your project, you can pick one from here.



<textarea class="textarea" id="txtarea" onClick="SelectAll('txtarea');">

title: "" date: draft: false author: "" description: "" filter: [""] bg_image: "/images/icons/icon-purple-network-new.png" type: "project" in_progress: false completed: true show_on_projects: true allow_click_through: false percent_complete: 100 github_url: "" project_url: "" reddit_url: "" twitter_url: "" weight: 0

</textarea> Copy to clipboard

Here's an example of a completed template for Nav Explorer:

nav-explorer
<textarea class="textarea" id="txtarea">

title: "Nav Explorer" date: 2018-03-10T14:29:06+13:00 draft: false author: "Prodpeak" description: "Alternative block explorer written in Java. This will offer redundancy if there are any issues with the current cryptoid block explorer." filter: ["Network"] bg_image: "/images/icons/icon-purple-network-new.png" type: "project" in_progress: false completed: true show_on_projects: true allow_click_through: false percent_complete: 100 github_url: "https://github.com/NavExplorer" project_url: "http://www.navexplorer.com" reddit_url: "" twitter_url: "" weight: 0

</textarea> {{< /text_block >}}

{{< text_block title="Step 3: Commit and create a pull request" >}}
Tips: Pull requests let you tell others about the changes you are about to make to the NavHub.org website, the changes won't happen straight away until it's approved by 4 other contributors. Here is how to do it

  1. Commit - after you happy with the Markdown file, scroll down and hit Commit new file. Add some comments and decriptions if you need to for others to know more about your change.



2. Add Reviewers



3. After you commit, a new page will show up. Click on Create pull request so people can see your changes. You can see your pull request as the first item here.

{{< /text_block >}}

{{< text_block title="Congrats!" >}}
Well done! You just created you project card on NavHub!

Again, this won't go live straight away because any change to the navhub.org site needs to be reviewed by the community members. To speed things up, it would be greate to share your pull request link to dicord.

{{< /text_block >}}

How do i get involved

{{< text_block title="From NavHub to the Community Fund" >}} 1. If you think you have a greate idea and wish to delivery a major improvement to to the NavCoin ecosystem, it would be greate to communicate with other NavCoin members,and submit your idea to the Discord Projects Channel.

2. Disuss and refine your news ideas with the community members and get some buy-ins.

3. Pulish the polished idea onto Nav Collab.

4. Great! Now you can apply for the NavCoin Community Fund with has a link to you the project on Nav Collab and get paid for working and deliverying you ideas. Check out the community fund page here. {{< /text_block >}}

<script type="text/javascript"> function copyTxt(){ var copyText = document.getElementById("txtarea"); copyText.select(); document.execCommand("copy"); } function SelectAll(id) { document.getElementById(id).focus(); document.getElementById(id).select(); } </script>

{{< community >}}