Skip to content

Commit

Permalink
docs: update README files
Browse files Browse the repository at this point in the history
  • Loading branch information
dawidsowardx committed Sep 30, 2024
1 parent b74c22e commit ba9454f
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 98 deletions.
46 changes: 42 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# dApps Monorepo 👋
# Radix dApps Monorepo 👋

## Required
## Table of Contents
[TOC]

## Prerequisites

You need to have the following tools installed to run the local development server:

- Node v20.3.0
- NPM v9.7.1
- Node >= 20
- NPM
- [Docker client](https://www.docker.com)

## Getting started
Expand Down Expand Up @@ -46,6 +49,41 @@ npm run pre-push
npm run test
```

# dApps

## Dashboard

##### [Mainnet](https://dashboard.radixdlt.com/)[Stokenet](https://stokenet-dashboard.radixdlt.com/)[Development](https://dev-dashboard.rdx-works-main.extratools.works/)


Search for addresses and transactions on the Radix Network. Participate in Radix Network staking using XRD tokens.

## Console

##### [Mainnet](https://console.radixdlt.com/)[Stokenet](https://stokenet-console.radixdlt.com/)[Development](https://dev-console.rdx-works-main.extratools.works/)

A collection of utility pages to help you during development of your own dApps.

## Sandbox

##### [Mainnet](https://sandbox.radixdlt.com/)[Stokenet](https://stokenet-sandbox.radixdlt.com/)[Development](https://dev-sandbox.rdx-works-main.extratools.works/)

A configurable dApp frontend simulator to let you experiment with Radix Wallet logins and requests for data. Development environment contains additional pages which can be used to play around with various wallet and network features.

# Packages

## common

Wrapper package for dependencies reused in different dApps. It contains dependencies that almost every Radix-based project needs like [RDT](https://github.com/radixdlt/radix-dapp-toolkit), [Gateway SDK](https://www.npmjs.com/package/@radixdlt/babylon-gateway-api-sdk), [Core SDK](https://www.npmjs.com/package/@radixdlt/babylon-core-api-sdk), [Rola](https://github.com/radixdlt/rola), [RET](https://github.com/radixdlt/typescript-radix-engine-toolkit).

## ui

Set of svelte components reused between Dev Console and Dashboard apps. Contains main dApp layout - header, side menu and other smaller components.

## eslint-config-custom

Custom ESLint configuration used by other packages and apps.

# License

* [Radix Dashboard](apps/dashboard/README.md#license)
Expand Down
40 changes: 3 additions & 37 deletions apps/console/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
### Running locally

```
yarn
yarn dev
npm
npm run dev
```

or with Docker:
Expand All @@ -28,43 +28,9 @@ make run-nginx
For unit tests:

```
yarn test
npm run test
```

### Run storybook

```
yarn storybook
```

### Gateway SDK

There's a specific command for updating the gateway sdk dependency:

```
PUBLIC_NETWORK_NAME=<network> yarn update:gateway
```

where `<network>` is the network (hammunet, etc) to use.

This updates the gateway sdk, and generates mocks for all the api responses.

In order for the UI tests to work, this command should be used when updating the gateway sdk.

### Code structure

## Components

Components are defined under the `components` folder, which has a subfolder named `_base`. The `_base` folder contains lower level base components, such as `button`. These are generally made to be reused by higher level components.

Most components are accompanied by a story, for example `button.stories.svelte`. We use [storybook](https://storybook.js.org/) to implement stories. Stories and unit tests live right next to component files.

## Styling

We use [stitches](https://stitches.dev/) to implement and organize our css. This gives us convenient tools to manage theming and reusable styles. Styles are defined in the component `<script>` tag.

For theming and other repo-wide style config, there's a `src/styles.ts` file with definitions for things like colors and spacing. Having a robust style config, and always referring to it when creating styles helps us keep the look and feel of the UI consistent.

# License

The Radix Developer Console code is released under [Apache 2.0 license](LICENSE).
Expand Down
3 changes: 1 addition & 2 deletions apps/console/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@
"prettier:fix": "prettier --config ../../.prettierrc --ignore-path ../../.prettierignore --cache --write --check .",
"lint": "eslint --cache --no-error-on-unmatched-pattern .",
"lint:fix": "eslint --cache --fix --no-error-on-unmatched-pattern .",
"coverage": "vitest run --coverage",
"update:gateway": "ts-node --esm ./scripts/update-gateway.ts"
"coverage": "vitest run --coverage"
},
"devDependencies": {
"@apidevtools/json-schema-ref-parser": "^10.1.0",
Expand Down
26 changes: 0 additions & 26 deletions apps/dashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,32 +46,6 @@ integration tests are written using [svelte-testing-library](https://github.com/
yarn storybook
```

### Gateway SDK
There's a specific command for updating the gateway sdk dependency:

```
PUBLIC_NETWORK_NAME=<network> yarn update:gateway
```

where `<network>` is the network (hammunet, etc) to use.

This updates the gateway sdk, and generates mocks for all the api responses.

In order for the UI tests to work, this command should be used when updating the gateway sdk.
### Code structure

## Components

Components are defined under the `components` folder, which has a subfolder named `_base`. The `_base` folder contains lower level base components, such as `button`. These are generally made to be reused by higher level components.

Most components are accompanied by a story, for example `button.stories.svelte`. We use [storybook](https://storybook.js.org/) to implement stories. Stories and unit tests live right next to component files.

## Styling

We use [stitches](https://stitches.dev/) to implement and organize our css. This gives us convenient tools to manage theming and reusable styles. Styles are defined in the component `<script>` tag.

For theming and other repo-wide style config, there's a `src/styles.ts` file with definitions for things like colors and spacing. Having a robust style config, and always referring to it when creating styles helps us keep the look and feel of the UI consistent.

# License

The Radix Dashboard code is released under [Apache 2.0 license](LICENSE).
Expand Down
1 change: 0 additions & 1 deletion apps/dashboard/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
"lint": "eslint --cache --no-error-on-unmatched-pattern .",
"lint:fix": "eslint --cache --fix --no-error-on-unmatched-pattern .",
"coverage": "vitest run --coverage",
"update:gateway": "ts-node --esm ./scripts/update-gateway.ts",
"db:migrate:dev": "prisma migrate dev",
"db:reset": "prisma migrate reset",
"db:generate": "prisma generate",
Expand Down
28 changes: 0 additions & 28 deletions packages/ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,31 +36,3 @@ yarn test
```
yarn storybook
```

### Gateway SDK
There's a specific command for updating the gateway sdk dependency:

```
PUBLIC_NETWORK_NAME=<network> yarn update:gateway
```

where `<network>` is the network (hammunet, etc) to use.

This updates the gateway sdk, and generates mocks for all the api responses.

In order for the UI tests to work, this command should be used when updating the gateway sdk.
### Code structure

## Components

Components are defined under the `components` folder, which has a subfolder named `_base`. The `_base` folder contains lower level base components, such as `button`. These are generally made to be reused by higher level components.

Most components are accompanied by a story, for example `button.stories.svelte`. We use [storybook](https://storybook.js.org/) to implement stories. Stories and unit tests live right next to component files.

## Styling

We use [stitches](https://stitches.dev/) to implement and organize our css. This gives us convenient tools to manage theming and reusable styles. Styles are defined in the component `<script>` tag.

For theming and other repo-wide style config, there's a `src/styles.ts` file with definitions for things like colors and spacing. Having a robust style config, and always referring to it when creating styles helps us keep the look and feel of the UI consistent.


0 comments on commit ba9454f

Please sign in to comment.