Skip to content
Permalink
Browse files

add readme

  • Loading branch information...
kolife01 committed Aug 14, 2019
1 parent cf9f2a4 commit b837f42765cff79f913bcbf2ea01b0e1e90f166c
Showing with 21 additions and 32 deletions.
  1. +17 −6 README.md
  2. BIN resources/repository/top.png
  3. +0 −22 templates/README.md
  4. +4 −4 templates/plugins/config.ts
@@ -3,6 +3,8 @@

:tada: Satellites - Launch a DEX Marketplace of NFT

:earth_americas: The satellite uses the 0x protocol and the original extension contract.

:mega: The Satellites team uses [IssueHunt](https://issuehunt.io/) for a sustainable open-source ecosystem.

## Quick start
@@ -20,19 +22,28 @@ $ npm install
$ npm run dev
```

#### Pre-requirements
#### Customization
1. Open the `plugins/config.ts` file and edit the params:

- `networkIdToTokens` -- The Ethereum address which be hundled assets.
- `networkIdToTokens` -- The Ethereum address which be hundled assets of ERC721.(default CryptoKitties) More information of the other assets can be [found here](https://github.com/block-base/satellites/wiki/ERC721-Asset-List).

- `addressToFee` -- The Ethereum address which should be specified as the fee recipient in orders your relayer accepts.
- `recipientAddress` -- The Ethereum address which you receive the fee recipient in orders your relayer.

- `ratio` -- The flat taker fee you'd like to receive for filled orders hosted by you
- `feeRatio` -- The percentage of the fee recipient of you.

2. Open the `nuxt.config.ts`file and edit service name etc.

## Community
- [Discord](https://discord.gg/swnEJUf)
## Supporting Satellites
Satellite is an open source project. This is an independent project.
When using satellites, a fee of the marketplace sales (default 1%) will be provided to satellites development funds.
The money is distributed to contributors and maintainers. And If you use Satellites please consider becoming a backer:

[![Let's fund issues in this repository](https://issuehunt.io/static/embed/issuehunt-button-v1.svg)](https://issuehunt.io/r/block-base/satellites)

## More Infomation
- [Discord](https://discord.gg/tdTegPC)
- [Twitter](https://twitter.com/satellites_js)
- [Medium](https://medium.com/blockbase)

## License
[Apache license 2.0](./LICENSE)
BIN +766 Bytes (100%) resources/repository/top.png
Binary file not shown.

This file was deleted.

@@ -21,14 +21,14 @@ const networkIdToAPI: { [networkId: number]: string } = {
const networkIdToTokens: { [networkId: number]: any[] } = {
1: [
{
contract: '0xdceaf1652a131f32a821468dc03a92df0edd86ea',
contract: '0x06012c8cf97bead5deae237070f9587f8e7a266d',
symbol: 'CK',
name: 'CryptoKitties'
}
],
4: [
{
contract: '0xc106d47fb4bf5f9ebaf46e3219ef3fabcbd26606',
contract: '0x16baf0de678e52367adc69fd067e5edd1d33e3bf',
symbol: 'CK',
name: 'CryptoKitties'
}
@@ -160,11 +160,11 @@ const networkIdToExceptions = {

const addressToFee = {
// 0 is satellitesAddress. This Fee goes to issueHunt and is returned to the developer.
'0':{
'0': {
recipients: '0x5926824315aF6016f98E83De841C5B28b959DF51',
ratio: 100
},
'1':{
'1': {
recipients: recipientAddress,
ratio: feeRatio
}

0 comments on commit b837f42

Please sign in to comment.
You can’t perform that action at this time.