105 lines
3.1 KiB
Markdown
105 lines
3.1 KiB
Markdown
# Add a New Deno Project
|
|
|
|
**Supported Features**
|
|
|
|
Because we are using an Nx plugin for Deno, all the features of Nx are available.
|
|
|
|
{% pill url="/core-features/run-tasks" %}✅ Run Tasks{% /pill %}
|
|
{% pill url="/core-features/cache-task-results" %}✅ Cache Task Results{% /pill %}
|
|
{% pill url="/core-features/remote-cache" %}✅ Share Your Cache{% /pill %}
|
|
{% pill url="/core-features/explore-graph" %}✅ Explore the Graph{% /pill %}
|
|
{% pill url="/core-features/distribute-task-execution" %}✅ Distribute Task Execution{% /pill %}
|
|
{% pill url="/core-features/integrate-with-editors" %}✅ Integrate with Editors{% /pill %}
|
|
{% pill url="/core-features/automate-updating-dependencies" %}✅ Automate Updating Nx{% /pill %}
|
|
{% pill url="/core-features/enforce-module-boundaries" %}✅ Enforce Module Boundaries{% /pill %}
|
|
{% pill url="/core-features/plugin-features/use-task-executors" %}✅ Use Task Executors{% /pill %}
|
|
{% pill url="/core-features/plugin-features/use-code-generators" %}✅ Use Code Generators{% /pill %}
|
|
{% pill url="/core-features/automate-updating-dependencies" %}✅ Automate Updating Framework Dependencies{% /pill %}
|
|
|
|
## Install the Deno Plugin
|
|
|
|
{% callout type="warning" title="Have Deno already installed?" %}
|
|
Make sure you have Deno installed on your machine. Consult the [Deno docs for more details](https://deno.com/manual/getting_started/installation)
|
|
{% /callout %}
|
|
|
|
{% tabs %}
|
|
{%tab label="npm"%}
|
|
|
|
```shell
|
|
npm i --save-dev @nx/deno
|
|
```
|
|
|
|
{% /tab %}
|
|
{%tab label="yarn"%}
|
|
|
|
```shell
|
|
yarn add --dev @nx/deno
|
|
```
|
|
|
|
{% /tab %}
|
|
{% /tabs %}
|
|
|
|
## Create an Application
|
|
|
|
Use the `app` generator to create a new Deno app.
|
|
|
|
```shell
|
|
nx g @nx/deno:app deno-app
|
|
```
|
|
|
|
Serve the API by running
|
|
|
|
```shell
|
|
nx serve deno-app
|
|
```
|
|
|
|
This starts the application on localhost:4200 by default.
|
|
|
|
## Create a Library
|
|
|
|
To create a new library, run:
|
|
|
|
```shell
|
|
nx g @nx/deno:lib my-lib
|
|
```
|
|
|
|
{% callout type="note" title="Deno Library Paths" %}
|
|
Deno library paths are maintained in the root `import_map.json` file. Because typescript doesn't understand how to parse this file, you may get errors in your code editor that are not problems during `build` or `serve`.
|
|
{% /callout %}
|
|
|
|
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/deno-app/src/handler.ts" %}
|
|
import { someFunction } from '@my-org/my-lib';
|
|
|
|
// deno-lint-ignore require-await
|
|
export async function handler(_request: Request): Promise<Response> {
|
|
const message = JSON.stringify({
|
|
message: 'Hello deno-app ' + someFunction(),
|
|
});
|
|
return new Response(message, {
|
|
status: 200,
|
|
headers: {
|
|
'content-type': 'application/json',
|
|
},
|
|
});
|
|
}
|
|
```
|
|
|
|
Now when you serve your app, you'll see the content from the library being displayed.
|
|
|
|
## More Documentation
|
|
|
|
- [@nx/deno](https://github.com/nrwl/nx-labs/tree/main/packages/deno)
|
|
- [Deno](https://deno.com)
|
|
|
|
{% cards cols="2" %}
|
|
{% card title="Converting an Express API To Deno" type="video" url="https://youtu.be/Um8xXR54upQ" /%}
|
|
{% /cards %}
|