Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stellarterm/stellarterm
Advanced web based trading client for the Stellar network. 📈📊💹💱
https://github.com/stellarterm/stellarterm
aws-lambda client nodejs react stellar stellar-network stellarterm
Last synced: about 1 month ago
JSON representation
Advanced web based trading client for the Stellar network. 📈📊💹💱
- Host: GitHub
- URL: https://github.com/stellarterm/stellarterm
- Owner: stellarterm
- Created: 2017-01-01T05:18:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T13:15:36.000Z (5 months ago)
- Last Synced: 2024-04-16T04:51:49.823Z (5 months ago)
- Topics: aws-lambda, client, nodejs, react, stellar, stellar-network, stellarterm
- Language: JavaScript
- Homepage: https://stellarterm.com
- Size: 11.5 MB
- Stars: 454
- Watchers: 21
- Forks: 229
- Open Issues: 175
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE-2.0.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/stellarterm/stellarterm)
# StellarTerm ecosystem - [client](https://stellarterm.com/) | [api](https://github.com/stellarterm/stellarterm-api)
## Web Client
StellarTerm is a web based trading client for use on the Stellar network. This client aims to make it easy and safe for users of any skill level to trade on the Stellar network by making a clear and secure user interface. Try it out at [https://stellarterm.com](https://stellarterm.com/)
## API for developers (built on AWS Lambda)
The StellarTerm API contains information on the markets on the Stellar network. This information is useful for the StellarTerm client itself as well as other developers that want to use this data.
The API uses the [Serverless framework](https://serverless.com/) for deployment to [AWS Lambda](https://aws.amazon.com/lambda/). The API data is hosted on AWS S3 for high availability.
It is currently under active development and is not yet finished. See it in action here: [https://api.stellarterm.com/](https://api.stellarterm.com/)
-------------------------------------------------------------------------------
## StellarTerm client custom network
### Testnet
To use the testnet, simply add `#testnet` or `/testnet` to the url to activate it. To exit, refresh the page where the url is not `/testnet`.
### Custom horizon builds
Some developers may want to use StellarTerm pointed to a custom horizon server or even a custom network. To do this, you must build StellarTerm locally.
The StellarTerm build process checks for the presence of relevant environment variables.
```sh
export STELLARTERM_CUSTOM_HORIZON_URL="https://horizon-testnet.stellar.org"
export STELLARTERM_CUSTOM_NETWORK_PASSPHRASE="Test SDF Network ; September 2015"
```
Once built, the configuration will be embedded into the StellarTerm output file (and the environment variable is no longer needed). To check this, look at the output of `index.html` and search for `stCustomConfig`.
## Deployment
The project is hosted on GitHub pages in the [stellarterm/stellarterm.github.io](https://github.com/stellarterm/stellarterm.github.io/) repository. The client is wrapped into a single html file and it's sha 256 sum is recorded on each git commit.
## Client development instructions
### Prerequisites
Make sure you have Node.js 7.4.0 or higher installed. If not, install it ([Node version manager](https://github.com/creationix/nvm) is recommended).
```sh
# Check your node version using this command
node --version
```
### Environment Setup
```sh
# Clone the project
git clone https://github.com/stellarterm/stellarterm.git
cd stellarterm
# Install the npm and bower dependencies
npm run setup
```
### Development mode
The build process has tools watches the code and rebuilds if something has changed. It will also serve the app locally (usually http://localhost:3000) and automatically refresh the page when changes are built.
```sh
npm start
```
### Production build
This builds a single index.html file with assets inlined. The single file contains the whole app and can be hosted online. Output file is in `./dist/index.html`.
```sh
npm run production
```
## License
Products in the StellarTerm ecosystem is open source software and is licensed under the [Apache-2.0 license](https://github.com/stellarterm/stellarterm/blob/master/LICENSE-2.0.txt). Please understand the license carefully before using StellarTerm.
## Credits
- Started the project using the super helpful [react-gulp-browserify yeoman generator](https://github.com/randylien/generator-react-gulp-browserify)