Skip to content

Commit

Permalink
Create DEVELOPMENT.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tchambard authored Oct 2, 2024
1 parent e80bc36 commit 21fa0c8
Showing 1 changed file with 74 additions and 0 deletions.
74 changes: 74 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
[![Prod](https://github.com/tchambard/solidr/actions/workflows/ci_prod.yml/badge.svg)](https://github.com/tchambard/solidr/actions/workflows/ci_prod.yml) [![Dev](https://github.com/tchambard/solidr/actions/workflows/ci.yml/badge.svg)](https://github.com/tchambard/solidr/actions/workflows/ci.yml)

Developed on Solana.

## The authors

- Chambard Teddy
- Coquelet Nicolas
- Vardon Adrien

## Useful links

- website: https://solidr.vercel.app
- program: https://explorer.solana.com/address/7kUL66rcAhxgisSeBtXoH7Pn9C5hWZa4m2Bp9mRcwtmv?cluster=devnet

## Technical stack

- Solana / Anchor
- Next.js / Tailwind / Typescript

# How to contribute

## How to develop with docker

cf [solana-test-validator-docker](https://github.com/tchambard/solana-test-validator-docker)

## How to use this repository

See all scripts in main package.json file.

### Install dependencies

```sh
yarn install
```

### Compile all packages

```sh
yarn run compile:all
```

### Apply lint rules

```sh
yarn run lint:all
```

### Run unit tests

```sh
yarn run test:all
```

### Useful scripts

Inside `packages/programs/solidr-program`

```sh
yarn run use-local -> solana-docker config set --url localhost --keypair /opt/.config/solana/id.json
yarn run deploy-local -> anchor-docker deploy --provider.cluster localhost
yarn run init-local -> ANCHOR_PROVIDER_URL=http://localhost:8899 ts-node migrations/initGlobal.ts
yarn run use-devnet -> solana-docker config set --url devnet --keypair /opt/.config/solana/id.json
yarn run deploy-devnet -> anchor-docker deploy --provider.cluster devnet
yarn run init-devnet -> ANCHOR_PROVIDER_URL=https://api.devnet.solana.com ts-node migrations/initGlobal.ts
yarn run start-local-test-validator -> solana-docker-shell exec "solana-test-validator --ledger /opt/.config/solana/.ledger --bind-address 0.0.0.0 --rpc-port 8899"
```

## Deployments

### Devnet deployed program

- program ID: 7kUL66rcAhxgisSeBtXoH7Pn9C5hWZa4m2Bp9mRcwtmv
- init global tx: Cww3SNfRfJEAaKgBeRGp1Jy16m3LVe3djfJB9kzwQ2wAFHBHMQ5T8sqAh1p5a6ShHxrtbJt6VQb1w5dGFzcGrgZ

0 comments on commit 21fa0c8

Please sign in to comment.