-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Address #579 by re-adding index pages on offending sections
- Loading branch information
Showing
6 changed files
with
23 additions
and
61 deletions.
There are no files selected for viewing
This file contains 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
This file was deleted.
Oops, something went wrong.
This file contains 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,13 @@ | ||
# Dependencies | ||
|
||
To run the Fuel indexer, you'll need to install a few dependencies on your system: | ||
|
||
- [`fuelup`](./fuelup.md), the Fuel toolchain manager | ||
- a supported [database](./database.md) | ||
- We support Postgres at this time | ||
- the [`wasm32-unknown-unknown`](./wasm.md) Rust compilation target | ||
- [`wasm-snip`](./wasm.md), a utility for trimming WebAssembly binaries | ||
|
||
If you don't want to install a database directly onto your system, you can use Docker to run it as an isolated container. You can install it by following the [install instructions](https://docs.docker.com/get-docker/). For reference purposes, we provide a [`docker compose` file](https://github.com/FuelLabs/fuel-indexer/blob/master/scripts/docker-compose.yaml) that runs a Postgres database and the Fuel indexer service. | ||
|
||
Also, it's assumed that you have the Rust programming language installed on your system. If that is not the case, please refer to the [Rust installation instructions](https://www.rust-lang.org/tools/install) for more information. |
This file contains 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,11 +1,10 @@ | ||
# Database | ||
|
||
The Fuel indexer uses [Postgres](https://github.com/docker-library/postgres/blob/2f6878ca854713264ebb27c1ba8530c884bcbca5/14/bullseye/Dockerfile) as the primary database. | ||
. | ||
The Fuel indexer uses [PostgreSQL](https://github.com/docker-library/postgres/blob/2f6878ca854713264ebb27c1ba8530c884bcbca5/14/bullseye/Dockerfile) as the primary database. We're open to supporting other storage solutions in the future. | ||
|
||
In this section, you can find information regarding how your data should be structured for use in the Fuel indexer: | ||
|
||
- [Types](./types.md) | ||
- How to use different data types from your Sway contract, all the way to your Postgres table | ||
- [Foreign Keys](./foreign-keys.md) | ||
- How foreign keys are handled in GraphQL schema, and Postgres. | ||
- How foreign keys are handled in the Fuel indexer. | ||
- [⚠️ IDs](./ids.md) | ||
- Explains some conventions surrounding the usage of `ID` types |
This file was deleted.
Oops, something went wrong.
This file contains 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,6 +1,7 @@ | ||
# GraphQL | ||
|
||
The Fuel indexer uses GraphQL to in order to allow users to query for indexed data. Please note that the Fuel indexer does not support the full GraphQL specification; however, we do our best to reasonably support as much as we can. In this chapter, you can find information on how to leverage our supported features to efficiently get the data you want. | ||
|
||
- [GraphQL API Server](./api-server.md) | ||
- [Directives](./directives.md) | ||
- [Schema](./../assets/schema.md.md) | ||
- [Types](./../database/types.md) | ||
- [Schema](./schema.md) |