Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix typos #52

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix typos #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

Monorepo for offchain infrastructure services.

The repository leverages [Nrwl's Nx](https://nx.dev/getting-started/intro) monorepo management tools. This makes it very easy to link shared libraries to multiple apps while maintaining seperation and CI speeds with only running tasks affected by change and computation caching.
The repository leverages [Nrwl's Nx](https://nx.dev/getting-started/intro) monorepo management tools. This makes it very easy to link shared libraries to multiple apps while maintaining separation and CI speeds with only running tasks affected by change and computation caching.

Nx has a lot of [code generators](https://nx.dev/getting-started/intro) to make it easier to maintain and enforce consistency across the monorepo.
These generators automatically generate some useful targets (such as build and test), setup file structures, and link base tsconfig and eslint configuration files to the root of the monorepo.

To make it easier to remember there are two yarn scripts which can be used to generate `node apps` and `js libs`. This can be extended in the future to include `ui` and `ui component library` generators. These sripts are `generate:lib` and `generate:node` and take 1 argument being the name of the library you are generating.
To make it easier to remember there are two yarn scripts which can be used to generate `node apps` and `js libs`. This can be extended in the future to include `ui` and `ui component library` generators. These scripts are `generate:lib` and `generate:node` and take 1 argument being the name of the library you are generating.
eg. `generate:lib example-lib`. This will automatically prepend `@mycelium-ethereum/` to `example-lib` so then you can import the library as `import ExampleLib from '@mycelium-ethereum/example-lib'`

Since a lot of Nx runs on generators and file tsconfig links, they provide a lot of useful tooling for things such as renaming or moving variables (since this might have unknown side effects to the developer). An example of this can be found with [@nrwl/workspace:move](https://nx.dev/packages/workspace/generators/move) which provides an easy plugin to move a package from one place to another. Be sure to read the generators documentation before making any structural chages to the repository.
Since a lot of Nx runs on generators and file tsconfig links, they provide a lot of useful tooling for things such as renaming or moving variables (since this might have unknown side effects to the developer). An example of this can be found with [@nrwl/workspace:move](https://nx.dev/packages/workspace/generators/move) which provides an easy plugin to move a package from one place to another. Be sure to read the generators documentation before making any structural changes to the repository.

## Getting started

Install dependencies (yarn preffered)
Install dependencies (yarn preferred)
`npm install` or `yarn`
This will install all dependencies required by all packages. During the build stage packages generate their own package.json if `generatePackageJson` is set to true in the [webpack configuration](https://nx.dev/packages/webpack/executors/webpack#generatepackagejson). This is optimised such that the distributed package does not have unused libraries included in the package.json.
This will install all dependencies required by all packages. During the build stage packages generate their own package.json if `generatePackageJson` is set to true in the [webpack configuration](https://nx.dev/packages/webpack/executors/webpack#generatepackagejson). This is optimized such that the distributed package does not have unused libraries included in the package.json.

## Running packages

Expand All @@ -38,7 +38,7 @@ To run this in development mode run

## [@mycelium-ethereum/swaps-prices](packages/swaps-prices)

A seperate pricing service which uses the same websockets as the priceKeepers, serves these prices over a websocket and http server.
A separate pricing service which uses the same websockets as the priceKeepers, serves these prices over a websocket and http server.

To run this in development mode run
`yarn dev:prices`
Expand Down