This repository was archived by the owner on Jun 22, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 251
WIP: General site reorganization #134
Merged
Merged
Changes from 6 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
236ed05
Change tools page to list all components
Mr0grog 8b3024c
Moving docs around between the different parts of "learn"
Mr0grog b9ca831
Merge branch 'master' of https://github.com/stellar/docs into nav-res…
Mr0grog 0add147
Split "tools" into "tools" and "software" (e.g. core, horizon, federa…
Mr0grog 76924e3
Move things-to-build under guides
Mr0grog 25ca850
Retitle things-to-build to "build stellar apps"
Mr0grog 7689d3c
New network overview text from Google doc.
Mr0grog 09d23d4
Remove paragraph about needing a regionally local core.
Mr0grog 0abc1d9
Add `contributing` document to guides.
Mr0grog a44e25d
Move integration-guides section up a level.
Mr0grog 81d23c8
Merge branch 'master' into nav-restructure
irisli File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Stellar Overview | ||
--- | ||
 | ||
|
||
The Stellar ecosystem is made up of several pieces of software. Depending on what you're doing with Stellar, you'll interact with or run different pieces of the ecosystem. | ||
|
||
[placeholder: this will be the lay of the land doc] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
title: Sending and Receiving Money | ||
--- | ||
[placeholder] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,12 @@ | ||
Build cool things on Stellar! This list outlines a few ideas for applications. Feel free to add your own or take one here and run with it. | ||
--- | ||
title: Build Stellar Apps | ||
--- | ||
Build cool things on Stellar! This list outlines a few ideas for applications. Feel free to add your own or take one here and run with it. | ||
As always, if you need help building anything with Stellar, just ask us ([Slack chat](http://slack.stellar.org/)),[IRC](https://kiwiirc.com/client/irc.freenode.net/#stellar-dev), or [email protected]) . | ||
|
||
If you're not looking for a full-blown project but still want to help out, look for `help wanted` issue labels in any of our [repos](https://github.com/stellar). | ||
|
||
# Slack Bot | ||
# Slack Bot | ||
- Report a stream of all stellar transactions to a channel. | ||
- *Advanced*: Allow people to send money/points/+1's to other Slack team members `/send @bob $5`. | ||
|
||
|
@@ -32,7 +35,7 @@ Allow anyone to send lumens from their Stellar client to any email address. They | |
|
||
This would be a service hosted at `domain.com` that does the following: | ||
- Runs a federation server. | ||
- Will federate payment addresses with an email prefix like `[email protected]*domain.com`. | ||
- Will federate payment addresses with an email prefix like `[email protected]*domain.com`. | ||
- If there is a federation request for an address you don't know that starts with a valid email address: | ||
- Generate a key pair | ||
- return the generated public key as the accountID | ||
|
@@ -46,7 +49,7 @@ This would be a service hosted at `domain.com` that does the following: | |
Let's say you have a public-facing service, perhaps for streaming or open wifi. You want to allow other people to use this service if they pay you small amounts. These payments could be used as spam prevention or to support your business. This is a job for the **toll collector**... | ||
|
||
## Toll Collector | ||
A simple service that keeps track of any XLM sent to a `toll address`. The toll collector has a database of public keys and amounts of XLM it has sent to the toll address. It watches for payments to the toll address on the Stellar network and adds them to this DB. | ||
A simple service that keeps track of any XLM sent to a `toll address`. The toll collector has a database of public keys and amounts of XLM it has sent to the toll address. It watches for payments to the toll address on the Stellar network and adds them to this DB. | ||
|
||
The toll collector service has one RPC or endpoint that you can call: | ||
|
||
|
@@ -67,7 +70,7 @@ Ideally the multisig coordinator includes the following features: | |
- Create a tx that you would like to be signed by multiple parties | ||
- Enter the public keys that you would like to sign the tx | ||
- If any of these keys have previously associated their email address, then they will be sent a message | ||
- When you come to the site you see a list of all pending transactions: | ||
- When you come to the site you see a list of all pending transactions: | ||
- You can see the details of each transaction | ||
- You can see who initiated the transaction | ||
- You can see who else has signed the transaction | ||
|
@@ -84,7 +87,7 @@ A web page that shows the state of the network quorum graph. Ideally the quorum | |
|
||
You should be able to view the quorum graph from the point of view of any given validator. You would probably need to run stellar-core to build the quorum monitor. You can get the data from the stellar-core logs and the /quorum command. | ||
|
||
*Advanced*: Build a server that connects to stellar-core and monitors the externalized messages and the various validator broadcasts. | ||
*Advanced*: Build a server that connects to stellar-core and monitors the externalized messages and the various validator broadcasts. | ||
|
||
# Libraries | ||
Build a library in your favorite language: | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: Stellar Software | ||
--- | ||
# Software | ||
|
||
Pre-built software and services you can run on your own infrastructure, provided by Stellar.org. | ||
|
||
## [Stellar Core](../stellar-core/learn/admin.html) | ||
Stellar Core is the backbone of the Stellar network and does the hard work of validating and agreeing on the status of every transaction with other instances of Core through the Stellar Consensus Protocol (SCP). | ||
|
||
## [Horizon](https://github.com/stellar/horizon) | ||
Horizon is the client-facing API server for the Stellar ecosystem. It acts as the interface between Stellar Core and applications that want to access the Stellar network. If you are running Stellar Core, you will probably also want to run Horizon. | ||
|
||
## [Federation Server](https://github.com/stellar/federation) | ||
Go implementation of Federation protocol server. This federation server is designed to be dropped in to your existing infrastructure. It can be configured to pull the data it needs out of your existing DB. | ||
|
||
## [Bridge Server](https://github.com/stellar/bridge-server) | ||
Stellar’s Bridge server is an easier-to-use version of Horizon, meant to simplify compliance operations and other more complicated integrations. Because it stores and manages keys and account information, access to it should be well protected. Unlike Horizon, it should never be exposed to the public internet. | ||
|
||
## [Archivist](https://github.com/stellar/archivist) | ||
This is a small tool, written in Go, for working with stellar-core history archives directly. It is a standalone tool that does not require stellar-core, or any other programs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,16 @@ | ||
--- | ||
title: Tools Overview | ||
title: Stellar Tools | ||
--- | ||
# [Laboratory](https://www.stellar.org/laboratory) | ||
# Tools | ||
|
||
## [Laboratory](https://www.stellar.org/laboratory) | ||
Interactive way to learn the Stellar API. The source is available [here](https://github.com/stellar/laboratory). | ||
|
||
# [Account Viewer](https://www.stellar.org/account-viewer/) | ||
|
||
# Reference applications and sample code | ||
|
||
## [Account Viewer](https://github.com/stellar/account-viewer) | ||
Check your balance and send simple payments. This basic client is built on top of [Interstellar](https://github.com/stellar/interstellar) and connects to the live Stellar network. The source is available [here](https://github.com/stellar/account-viewer). | ||
|
||
## [SMS Client](https://github.com/stellar/stellar-sms-client) | ||
This is a demo of Stellar SMS Client. It was originally developed during Stellar Hack Day. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jessica-collier: @irisli suggested the page title and overview here could be a little better and more descriptive. (we probably don’t need the H1 at all)