-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9e4cd96
commit 2fdf80a
Showing
1 changed file
with
23 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,94 +1,37 @@ | ||
| # INJECTABLE-TS | ||
|
|
||
| Purely-functional strictly-typed IoC/DI for TypeScript. | ||
|
|
||
| # InjectableTs | ||
| ## Overview | ||
|
|
||
| This project was generated using [Nx](https://nx.dev). | ||
| This project aims at providing lightweight inversion of control (IoC) and dependency injection (DI) tooling for large JavaScript/TypeScript applications. | ||
|
|
||
| <p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="450"></p> | ||
| ## Motivation | ||
|
|
||
| 🔎 **Smart, Fast and Extensible Build System** | ||
| While concepts of IoC and DI are not new and there are multiple implementations of them available for JavaScript and TypeScript, | ||
| most of them are built around the concept of a single container with all registered dependencies (or multiple containers). | ||
|
|
||
| ## Adding capabilities to your workspace | ||
| While such approach might work for some projects, it still introduces tight coupling in the code. | ||
| We have to either manually register all dependencies in such container (which can be quite tedious), | ||
| or delegate it to a framework which will register them automatically on a single _global_ container which makes the code not portable. | ||
|
|
||
| Nx supports many plugins which add capabilities for developing different types of applications and different tools. | ||
| While the issues above might seem synthetic, there's still another major downside of such approach - | ||
| there is no way to _statically_ check whether all required dependencies are actually registered on the container. | ||
| If any of requested dependencies is missing, container throws in runtime which makes the code impure and indeterminate. | ||
|
|
||
| These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well. | ||
| So, the goals of this project are to: | ||
|
|
||
| Below are our core plugins: | ||
| - provide a purely-functional solution for automatic IoC/DI | ||
| - provide compile-time guarantees that all required dependencies are always available for the caller. | ||
|
|
||
| - [React](https://reactjs.org) | ||
| - `npm install --save-dev @nrwl/react` | ||
| - Web (no framework frontends) | ||
| - `npm install --save-dev @nrwl/web` | ||
| - [Angular](https://angular.io) | ||
| - `npm install --save-dev @nrwl/angular` | ||
| - [Nest](https://nestjs.com) | ||
| - `npm install --save-dev @nrwl/nest` | ||
| - [Express](https://expressjs.com) | ||
| - `npm install --save-dev @nrwl/express` | ||
| - [Node](https://nodejs.org) | ||
| - `npm install --save-dev @nrwl/node` | ||
| ## Structure | ||
|
|
||
| There are also many [community plugins](https://nx.dev/community) you could add. | ||
| The project is split into several packages, and you can find documentation for them in the corresponding readme files. | ||
|
|
||
| ## Generate an application | ||
| - [@injectable-ts/core](./packages/core/README.md) - the main package containing building blocks for the IoC/DI | ||
| - [@injectable-ts/react](./packages/react/README.md) - bindings for React for better integration with the core | ||
| - more coming soon | ||
|
|
||
| Run `nx g @nrwl/react:app my-app` to generate an application. | ||
| ## Development | ||
|
|
||
| > You can use any of the plugins above to generate applications as well. | ||
| When using Nx, you can create multiple applications and libraries in the same workspace. | ||
|
|
||
| ## Generate a library | ||
|
|
||
| Run `nx g @nrwl/react:lib my-lib` to generate a library. | ||
|
|
||
| > You can also use any of the plugins above to generate libraries as well. | ||
| Libraries are shareable across libraries and applications. They can be imported from `@injectable-ts/mylib`. | ||
|
|
||
| ## Development server | ||
|
|
||
| Run `nx serve my-app` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files. | ||
|
|
||
| ## Code scaffolding | ||
|
|
||
| Run `nx g @nrwl/react:component my-component --project=my-app` to generate a new component. | ||
|
|
||
| ## Build | ||
|
|
||
| Run `nx build my-app` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. | ||
|
|
||
| ## Running unit tests | ||
|
|
||
| Run `nx test my-app` to execute the unit tests via [Jest](https://jestjs.io). | ||
|
|
||
| Run `nx affected:test` to execute the unit tests affected by a change. | ||
|
|
||
| ## Running end-to-end tests | ||
|
|
||
| Run `nx e2e my-app` to execute the end-to-end tests via [Cypress](https://www.cypress.io). | ||
|
|
||
| Run `nx affected:e2e` to execute the end-to-end tests affected by a change. | ||
|
|
||
| ## Understand your workspace | ||
|
|
||
| Run `nx graph` to see a diagram of the dependencies of your projects. | ||
|
|
||
| ## Further help | ||
|
|
||
| Visit the [Nx Documentation](https://nx.dev) to learn more. | ||
|
|
||
|
|
||
|
|
||
| ## ☁ Nx Cloud | ||
|
|
||
| ### Distributed Computation Caching & Distributed Task Execution | ||
|
|
||
| <p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-cloud-card.png"></p> | ||
|
|
||
| Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly. | ||
|
|
||
| Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers. | ||
|
|
||
| Visit [Nx Cloud](https://nx.app/) to learn more. | ||
| The project is entirely written in [TypeScript](https://www.typescriptlang.org/) and composed with [nx](https://nx.dev/). |