Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/snapshot-labs/sx-monorepo
Snapshot monorepo
https://github.com/snapshot-labs/sx-monorepo
Last synced: about 2 months ago
JSON representation
Snapshot monorepo
- Host: GitHub
- URL: https://github.com/snapshot-labs/sx-monorepo
- Owner: snapshot-labs
- License: mit
- Created: 2023-11-07T11:04:12.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-30T17:41:46.000Z (about 2 months ago)
- Last Synced: 2024-11-30T17:56:25.384Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://snapshot.box
- Size: 12.3 MB
- Stars: 17
- Watchers: 5
- Forks: 17
- Open Issues: 78
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/snapshot-labs/sx-monorepo/actions/workflows/test.yml)
[](https://discord.snapshot.org/)
# Snapshot X monorepository
This is an Snapshot X monorepository.
## Apps and Packages
- `ui`: Snapshot X front-end written in Vue
# Usage
## Project setup
```
yarn
```
### Compiles and hot-reloads for development
#### UI only
```sh
yarn dev
```
#### UI with backend services
[See here.](./README.md#running-local-services)
### Compiles and minifies for production
```
yarn build
```
### Lints and fixes files
```
yarn lint
```
### Runs tests
```
yarn test
```
### Verifies TypeScript code
```
yarn typecheck
```
## Running local services
You can run all local services (api, subgraph-api, mana, ui) with single command assuming you have all necessary environment variables set up.
Local APIs will only be used for Ethereum Sepolia and Starknet Sepolia.
```
yarn dev:full
```
### Setup
You need to have Docker running on your machine.
In `apps/api` and `apps/mana` copy `.env.example` to `.env` files.
In `apps/mana/.env` you need to fill in following empty variables:
- `STARKNET_MNEMONIC` and `ETH_MNEMONIC` - if you want to use it as relayer.
- `HERODOTUS_API_KEY` and `HERODOTUS_LEGACY_API_KEY` - if you want to use L1<->L2 messaging (voting with strategies that use L1 proofs)
### Getting it running faster
If you run `yarn dev:full` it will take long time to sync all the blocks for the first time. To mitigate it you can just change starting block
for indexing here:
- https://github.com/snapshot-labs/sx-monorepo/blob/0f767b8c69d6986d06c70eb4a1ed7cb33e235b5a/apps/api/src/overrrides.ts#L50 (for Starknet)
- https://github.com/snapshot-labs/sx-monorepo/blob/0f767b8c69d6986d06c70eb4a1ed7cb33e235b5a/apps/subgraph-api/networks.json#L12-L21 (for Ethereum)
If you do that make sure to create a new space, because spaces created before the new starting block you picked won't be available.
## Versioning packages
Packages are versioned using [`changesets`](https://github.com/changesets/changesets).
In most cases all you need to do is when adding new changes to versioned packages (right now it's just `sx.js`)
is to execute `yarn changeset`, specify package you updated, version bump per [semver](https://semver.org/) and description of your changes.
Then commit generated files in your PR.
Once merged changesets actions will create PR that can be used to release and publish those packages.