Skip to content

Commit

Permalink
feat: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
toniocodo committed Sep 5, 2023
1 parent 3f3544a commit 1a4d86a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 13 deletions.
30 changes: 20 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
# Origin Defi

## Start any the app
## Setup environment

To start the development server run `nx serve ousd` or `nx serve oeth`. Open your browser and navigate to http://localhost:4200/. Happy coding!
Duplicate `.env` file to `.env.local` and fill the variables with your secrets, they will take precedence over the defaults.

## Start the app

To start the development server run `pnpm nx serve oeth` or `pnpm nx serve ousd`. Open your browser and navigate to http://localhost:4200/. Happy coding!

## Apps

| Status | Name | Nx project | Port | Public hosts |
|:------:|:-----|:-----------|:-----|:-------------|
| 🚧 | OETH | `oeth` | 4200 | [fleek]() |
| 🚧 | OUSD | `ousd` | 4201 | [fleek]() |

## Storybook

There is a shared storybook aggregator that can run all the stories across all the libraries, run
`pnpm storybook`. If you want to run storybook for one individual library (eg: ousd) simply run `pnpm nx storybook defi-ousd` (basically the command is `pnpm nx storybook name-of-the-lib`).
There is a shared storybook aggregator that can run all the stories across all the libraries, run `pnpm storybook`. If you want to run storybook for one individual library (eg: ousd) simply run `pnpm nx storybook defi-ousd` (basically the command is `pnpm nx storybook name-of-the-lib`).

## Translations

Expand All @@ -17,20 +27,20 @@ Basic translation setup was added to the repo. It might require some changes dep

To execute tasks with Nx use the following syntax:

```
nx <target> <project> <...options>
```bash
pnpm nx <target> <project> <...options>
```

You can also run multiple targets:

```
nx run-many -t <target1> <target2>
```bash
pnpm nx run-many -t <target1> <target2>
```

..or add `-p` to filter specific projects

```
nx run-many -t <target1> <target2> -p <proj1> <proj2>
```bash
pnpm nx run-many -t <target1> <target2> -p <proj1> <proj2>
```

Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/core-features/run-tasks).
6 changes: 3 additions & 3 deletions apps/ousd/vite.config.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
/// <reference types="vitest" />
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import { defineConfig } from 'vite';
import viteTsConfigPaths from 'vite-tsconfig-paths';

export default defineConfig({
cacheDir: '../../node_modules/.vite/ousd',

server: {
port: 4200,
port: 4201,
host: 'localhost',
},

preview: {
port: 4300,
port: 4301,
host: 'localhost',
},

Expand Down

0 comments on commit 1a4d86a

Please sign in to comment.