diff --git a/README.md b/README.md index 4867c6413..57b15337a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 <...options> +```bash +pnpm nx <...options> ``` You can also run multiple targets: -``` -nx run-many -t +```bash +pnpm nx run-many -t ``` ..or add `-p` to filter specific projects -``` -nx run-many -t -p +```bash +pnpm nx run-many -t -p ``` Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/core-features/run-tasks). diff --git a/apps/ousd/vite.config.ts b/apps/ousd/vite.config.ts index 3c9a4c7c5..f79c647df 100644 --- a/apps/ousd/vite.config.ts +++ b/apps/ousd/vite.config.ts @@ -1,18 +1,18 @@ /// -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', },