Skip to content

Commit

Permalink
Merge pull request #803 from multiversx/Rebranding
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
danielailie authored Jan 10, 2023
2 parents e113847 + d6307dc commit 72e0d0c
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ GraphQl service to provide informations regarding nfts and auctions on Multivers

1. Node.js > @16.x.x is required to be installed [docs](https://nodejs.org/en/)
1. Redis Server is required to be installed [docs](https://redis.io/).
2. MySQL Server is required to be installed [docs](https://dev.mysql.com/doc/refman/8.0/en/installing.html).
3. MongoDB Server is required to be installed [docs](https://www.mongodb.com/docs/manual/installation).
1. MySQL Server is required to be installed [docs](https://dev.mysql.com/doc/refman/8.0/en/installing.html).
1. MongoDB Server is required to be installed [docs](https://www.mongodb.com/docs/manual/installation).

You can use `docker-compose up` in a separate terminal to use a local docker container for all these dependencies.

Expand All @@ -21,14 +21,17 @@ Runs the app in the production mode.
Make requests to [http://localhost:3005/graphql](http://localhost:3005/graphql).

## Running the app

1. At the root folder run (make sure you have node v16.x.x)

```bash
$ npm install
```

2. Create .env file from .env.example (all flags are disabled by default)

3. Start the app

```bash
# development debug mode
$ npm run start:debug
Expand All @@ -37,17 +40,19 @@ $ npm run start:dev
# production mode
$ npm run start:prod
```

It depends on the following external systems:
- gateway:

- gateway:
- interaction with the indexed marketplace
- docs: [https://docs.elrond.com/sdk-and-tools/proxy/](https://docs.elrond.com/sdk-and-tools/proxy/)
- index:
- docs: [https://docs.multiversx.com/sdk-and-tools/proxy/](https://docs.multiversx.com/sdk-and-tools/proxy/)
- index:
- to gather information regarding nft history
- docs: [https://docs.elrond.com/sdk-and-tools/elastic-search/](https://docs.elrond.com/sdk-and-tools/elastic-search/)
- api:
- docs: [https://docs.multiversx.com/sdk-and-tools/elastic-search/)
- api:
- to get information regarding nfts and collections
- docs: [https://docs.elrond.com/sdk-and-tools/rest-api/api-elrond-com](https://docs.elrond.com/sdk-and-tools/rest-api/api-elrond-com)
It uses on the following internal systems:
- docs: [https://docs.multiversx.com/sdk-and-tools/rest-api/multiversx-api/](https://docs.multiversx.com/sdk-and-tools/rest-api/multiversx-api/)
It uses on the following internal systems:
- redis: used to cache various data, for performance purposes
- rabbitmq: pub/sub for sending mainly NFT process information

Expand All @@ -63,12 +68,13 @@ A service instance can be started with the following behavior:
- multiple cronjobs: update data in elastic service for nsfw, rarity, traits, scam

It depends on the following optional external systems:

- events notifier rabbitmq: queue that pushes logs & events which are handled internally e.g. to trigger auctions indexing
- data: provides eGLD price information for transactions
- ipfs: ipfs gateway for uploading nft media and metadata
- AWS S3: used to upload nft media for faster performance

It uses the following optional internal systems:

- mysql database: used to store mainly auction information
- mongo database: used to store mainly NFT traits information

0 comments on commit 72e0d0c

Please sign in to comment.