-
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.
- Loading branch information
Showing
2 changed files
with
22 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,94 +1,44 @@ | ||
|
||
|
||
# NestDemo | ||
# Nest.js crypto API - Demo | ||
|
||
This project was generated using [Nx](https://nx.dev). | ||
|
||
<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="450"></p> | ||
|
||
🔎 **Smart, Fast and Extensible Build System** | ||
|
||
## Adding capabilities to your workspace | ||
|
||
Nx supports many plugins which add capabilities for developing different types of applications and different tools. | ||
|
||
These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well. | ||
## First run instruction | ||
|
||
Below are our core plugins: | ||
Install required dependencies | ||
|
||
- [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` | ||
`npm ci` | ||
|
||
There are also many [community plugins](https://nx.dev/community) you could add. | ||
Create a `.env` file and then complete with the required values. | ||
|
||
## Generate an application | ||
`cp .env.template .env` | ||
|
||
Run `nx g @nrwl/react:app my-app` to generate an application. | ||
Start development server | ||
|
||
> You can use any of the plugins above to generate applications as well. | ||
`npm run start` | ||
|
||
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 `@nest-demo/mylib`. | ||
Open your browser and navigate to Swagger documentation. | ||
|
||
## 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. | ||
Run `npm run start` for a dev server. Navigate to http://localhost:3000/api. The app will automatically reload if you change any of the source files. | ||
|
||
## 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. | ||
Run `npm run build` 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 | ||
Run `npm run test` to execute the unit tests. | ||
|
||
### Distributed Computation Caching & Distributed Task Execution | ||
Run `npm run test:affected` to execute the unit tests affected by a change. | ||
|
||
<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-cloud-card.png"></p> | ||
## Mocked user | ||
|
||
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. | ||
| Email | Password | | ||
| ------------------- | --------------- | | ||
| `admin@example.com` | `administrator` | | ||
| `mod@example.com` | `moderator` | | ||
|
||
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. | ||
## Application config | ||
|
||
Visit [Nx Cloud](https://nx.app/) to learn more. | ||
All you want to know about environment variables are [here](./libs/config/README.md). |
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