-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Octanium <octaniumcontact@gmail.com>
- Loading branch information
Showing
1 changed file
with
5 additions
and
71 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,76 +1,10 @@ | ||
| # ProblemJs | ||
|
|
||
| <a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a> | ||
| Problem-js is a JavaScript integration for the Problem Details for HTTP APIs standard (see [RFC 9457](https://datatracker.ietf.org/doc/html/rfc9457)) | ||
|
|
||
| ✨ **This workspace has been generated by [Nx, Smart Monorepos · Fast CI.](https://nx.dev)** ✨ | ||
| > [!NOTE] | ||
| > This file is still a Work In Progress... | ||
| ## Integrate with editors | ||
| ## How to contribute | ||
|
|
||
| Enhance your Nx experience by installing [Nx Console](https://nx.dev/nx-console) for your favorite editor. Nx Console | ||
| provides an interactive UI to view your projects, run tasks, generate code, and more! Available for VSCode, IntelliJ and | ||
| comes with a LSP for Vim users. | ||
|
|
||
| ## Nx plugins and code generators | ||
|
|
||
| Add Nx plugins to leverage their code generators and automated, inferred tasks. | ||
|
|
||
| ``` | ||
| # Add plugin | ||
| npx nx add @nx/react | ||
| # Use code generator | ||
| npx nx generate @nx/react:app demo | ||
| # Run development server | ||
| npx nx serve demo | ||
| # View project details | ||
| npx nx show project demo --web | ||
| ``` | ||
|
|
||
| Run `npx nx list` to get a list of available plugins and whether they have generators. Then run `npx nx list <plugin-name>` to see what generators are available. | ||
|
|
||
| Learn more about [code generators](https://nx.dev/features/generate-code) and [inferred tasks](https://nx.dev/concepts/inferred-tasks) in the docs. | ||
|
|
||
| ## Running tasks | ||
|
|
||
| To execute tasks with Nx use the following syntax: | ||
|
|
||
| ``` | ||
| npx nx <target> <project> <...options> | ||
| ``` | ||
|
|
||
| You can also run multiple targets: | ||
|
|
||
| ``` | ||
| npx nx run-many -t <target1> <target2> | ||
| ``` | ||
|
|
||
| ..or add `-p` to filter specific projects | ||
|
|
||
| ``` | ||
| npx 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/features/run-tasks). | ||
|
|
||
| ## Set up CI! | ||
|
|
||
| Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further. | ||
|
|
||
| - [Set up remote caching](https://nx.dev/features/share-your-cache) | ||
| - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) | ||
| - [Learn more how to setup CI](https://nx.dev/recipes/ci) | ||
|
|
||
| ## Explore the project graph | ||
|
|
||
| Run `npx nx graph` to show the graph of the workspace. | ||
| It will show tasks that you can run with Nx. | ||
|
|
||
| - [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) | ||
|
|
||
| ## Connect with us! | ||
|
|
||
| - [Join the community](https://nx.dev/community) | ||
| - [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools) | ||
| - [Follow us on Twitter](https://twitter.com/nxdevtools) | ||
| See [CONTRIBUTING.md](./CONTRIBUTING.md) |