dc67660fec
- Update artifact generator schemas: - Clarify `path` is the artifact file path relative to the current working directory - Clarify `name` is the artifact symbol name - Remove prompt for `name` and remove it from the important options (won't be displayed by default in Nx Console generation UI, it will be part of the collapsed options) given that most of the time, it's meant to match the filename (last segment of the `path`) - Remove some leftover options related to the name and path formats that were previously missed - Fix an issue with NestJS generators - Fix an issue with Next `page` generator <!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
97 lines
2.9 KiB
Markdown
97 lines
2.9 KiB
Markdown
# Add a New Fastify Project
|
|
|
|
{% youtube
|
|
src="https://www.youtube.com/embed/LHLW0b4fr2w"
|
|
title="Easy, Modular Node Applications!"
|
|
width="100%" /%}
|
|
|
|
**Supported Features**
|
|
|
|
Because we are using an Nx plugin for Fastify, all the features of Nx are available.
|
|
|
|
{% pill url="/features/run-tasks" %}✅ Run Tasks{% /pill %}
|
|
{% pill url="/features/cache-task-results" %}✅ Cache Task Results{% /pill %}
|
|
{% pill url="/ci/features/remote-cache" %}✅ Share Your Cache{% /pill %}
|
|
{% pill url="/features/explore-graph" %}✅ Explore the Graph{% /pill %}
|
|
{% pill url="/ci/features/distribute-task-execution" %}✅ Distribute Task Execution{% /pill %}
|
|
{% pill url="/getting-started/editor-setup" %}✅ Integrate with Editors{% /pill %}
|
|
{% pill url="/features/automate-updating-dependencies" %}✅ Automate Updating Nx{% /pill %}
|
|
{% pill url="/features/enforce-module-boundaries" %}✅ Enforce Module Boundaries{% /pill %}
|
|
{% pill url="/features/generate-code" %}✅ Use Code Generators{% /pill %}
|
|
{% pill url="/features/automate-updating-dependencies" %}✅ Automate Updating Framework Dependencies{% /pill %}
|
|
|
|
## Create a New Workspace with a Fastify App
|
|
|
|
If you're starting from scratch, you can use a preset to get you started quickly.
|
|
|
|
```shell
|
|
npx create-nx-workspace@latest --preset=node-monorepo --framework=fastify --appName=fastify-api
|
|
```
|
|
|
|
Then you can skip to the [Create a Library](#create-a-library) section.
|
|
|
|
If you are adding Fastify to an existing repo, continue to the next section.
|
|
|
|
## Install the Node Plugin
|
|
|
|
```shell {% skipRescope=true %}
|
|
nx add @nx/node
|
|
```
|
|
|
|
## Create an Application
|
|
|
|
Use the `app` generator to create a new Fastify app.
|
|
|
|
```shell
|
|
nx g @nx/node:app apps/fastify-api
|
|
```
|
|
|
|
Serve the API by running
|
|
|
|
```shell
|
|
nx serve fastify-api
|
|
```
|
|
|
|
This starts the application on localhost:3000/api by default.
|
|
|
|
## Create a Library
|
|
|
|
To create a new library, run:
|
|
|
|
```shell
|
|
nx g @nx/node:lib libs/my-lib
|
|
```
|
|
|
|
Once the library is created, update the following files.
|
|
|
|
```typescript {% fileName="libs/my-lib/src/lib/my-lib.ts" %}
|
|
export function someFunction(): string {
|
|
return 'some function';
|
|
}
|
|
```
|
|
|
|
```typescript {% fileName="apps/fastify-app/src/app/routes/root.ts" %}
|
|
import { someFunction } from '@my-org/my-lib';
|
|
import { FastifyInstance, FastifyRequest, FastifyReply } from 'fastify';
|
|
|
|
export default async function (fastify: FastifyInstance) {
|
|
fastify.get(
|
|
'/',
|
|
async function (request: FastifyRequest, reply: FastifyReply) {
|
|
return { message: 'Hello API ' + someFunction };
|
|
}
|
|
);
|
|
}
|
|
```
|
|
|
|
Now when you serve your API, you'll see the content from the library being displayed.
|
|
|
|
## More Documentation
|
|
|
|
- [@nx/node](/nx-api/node)
|
|
- [Using Mongo with Fastify](/showcase/example-repos/mongo-fastify)
|
|
- [Using Redis with Fastify](/showcase/example-repos/redis-fastify)
|
|
- [Using Postgres with Fastify](/showcase/example-repos/postgres-fastify)
|
|
- [Using PlanetScale with Serverless Fastify](/showcase/example-repos/serverless-fastify-planetscale)
|
|
- [Fastify](https://fastify.dev/)
|