-
-
Notifications
You must be signed in to change notification settings - Fork 4
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
24e97f2
commit 615ce39
Showing
1 changed file
with
52 additions
and
8 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 |
---|---|---|
|
@@ -27,20 +27,64 @@ Nitric SDKs provide an infrastructure-as-code style that lets you define resourc | |
|
||
You can request the type of access you need to resources such as publishing for topics, without dealing directly with IAM or policy documents. | ||
|
||
## Status | ||
- Reference Documentation: https://nitric.io/docs/reference/nodejs | ||
- Guides: https://nitric.io/docs/guides/nodejs | ||
|
||
The SDK is in early stage development and APIs and interfaces are still subject to breaking changes. We’d love your feedback as we build additional functionality! | ||
## Usage | ||
|
||
### Starting a new project | ||
|
||
Install the [Nitric CLI](https://nitric.io/docs/getting-started/installation), then generate your project: | ||
|
||
TypeScript: | ||
|
||
```bash | ||
nitric new hello-world ts-starter | ||
``` | ||
|
||
JavaScript: | ||
|
||
```bash | ||
nitric new hello-world js-starter | ||
``` | ||
|
||
### Adding to an existing project | ||
|
||
First of all, you need to install the library: | ||
|
||
```bash | ||
npm install @nitric/sdk | ||
``` | ||
|
||
Then you're able to import the library and create cloud resources: | ||
|
||
```typescript | ||
import { api, bucket } from '@nitric/sdk'; | ||
|
||
const publicApi = api('public'); | ||
const uploads = bucket('uploads').allow('write'); | ||
|
||
publicApi.get('/upload', async (ctx) => { | ||
const photo = uploads.file('images/photo.png'); | ||
|
||
const url = await photo.getUploadUrl({ | ||
expiry: 300, | ||
}); | ||
|
||
return ctx.res.json({ url }); | ||
}); | ||
``` | ||
|
||
## Learn more | ||
|
||
Learn more by checking out the [Nitric documentation](https://nitric.io/docs). | ||
|
||
## Get in touch: | ||
|
||
- Ask questions in [GitHub discussions](https://github.com/nitrictech/nitric/discussions) | ||
- Join us on [Discord](https://nitric.io/chat) | ||
|
||
- Join us on [Discord](https://discord.gg/Webemece5C) | ||
- Ask questions in [GitHub discussions](https://github.com/nitrictech/nitric/discussions) | ||
|
||
- Find us on [Twitter](https://twitter.com/nitric_io) | ||
|
||
- Send us an [email](mailto:[email protected]) | ||
|
||
## Get Started | ||
|
||
Check out the [Nitric docs](https://nitric.io/docs) to see how to get started using Nitric. |