https://github.com/stellar/freighter-backend
Freighter's indexer integration layer and general backend
https://github.com/stellar/freighter-backend
Last synced: about 1 year ago
JSON representation
Freighter's indexer integration layer and general backend
- Host: GitHub
- URL: https://github.com/stellar/freighter-backend
- Owner: stellar
- Created: 2023-10-18T18:14:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-03T14:42:52.000Z (about 1 year ago)
- Last Synced: 2025-04-03T15:41:39.797Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 509 KB
- Stars: 1
- Watchers: 14
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Code of conduct: CODE_OF_CONDUCT.MD
Awesome Lists containing this project
README
# Freighter-Backend
Freighter's indexer integration layer and general backend
## Prerequisites
You will need
- Node (>=20.0): https://nodejs.org/en/download/
- Yarn (>=v1.22.5): https://classic.yarnpkg.com/en/docs/install
## Development
This application relies on a Redis instance when `MODE=production`, you can either run `docker compose up` to use docker to stand up a Redis or you can start one on the standard port manually. If you're running in development mode, it uses a memory store.
To start the server in development mode, run:
`yarn i && yarn start`
For full runbook details, please reference [the runbook.](./docs/runbook.md)
## Production build
`yarn build:prod`
## Mercury Details
This project integrates with Mercury, an indexer for Stellar/Soroban. You can find general developer documentation (in their repo docs)[https://github.com/xycloo/merury-developers-documentation/blob/main/src/SUMMARY.md].
For full integration details, see [the Mercury docs](./docs/mercury.md).