deno/README.md

92 lines
2.3 KiB
Markdown
Raw Normal View History

2019-10-03 16:26:48 +00:00
# Deno
2018-05-18 16:25:59 +00:00
2020-09-29 15:40:17 +00:00
[![Build Status - Cirrus][]][Build status] [![Twitter handle][]][Twitter badge]
2019-03-05 05:01:32 +00:00
2020-09-29 15:40:17 +00:00
<img align="right" src=https://deno.land/logo.svg height="150px">
2019-02-20 04:25:52 +00:00
2020-09-29 15:40:17 +00:00
Deno is a _simple_, _modern_ and _secure_ runtime for **JavaScript** and
**TypeScript** that uses V8 and is built in Rust.
2019-02-22 04:22:44 +00:00
2020-09-29 15:40:17 +00:00
### Features
2019-02-20 04:25:52 +00:00
2020-09-29 15:40:17 +00:00
- Secure by default. No file, network, or environment access, unless explicitly
enabled.
- Supports TypeScript out of the box.
- Ships only a single executable file.
- Built-in utilities like a dependency inspector (deno info) and a code
formatter (deno fmt).
- Set of reviewed standard modules that are guaranteed to work with
[Deno](https://deno.land/std/).
2019-02-20 04:25:52 +00:00
2020-09-29 15:40:17 +00:00
### Install
2019-02-20 04:25:52 +00:00
2020-09-29 15:40:17 +00:00
Shell (Mac, Linux):
2019-02-20 04:25:52 +00:00
2020-09-29 15:40:17 +00:00
```sh
curl -fsSL https://deno.land/x/install/install.sh | sh
```
2019-02-20 04:25:52 +00:00
2020-09-29 15:40:17 +00:00
PowerShell (Windows):
2019-02-20 04:25:52 +00:00
2020-09-29 15:40:17 +00:00
```powershell
iwr https://deno.land/x/install/install.ps1 -useb | iex
```
2019-02-20 04:25:52 +00:00
2020-09-29 15:40:17 +00:00
[Homebrew](https://formulae.brew.sh/formula/deno) (Mac):
2019-02-20 04:25:52 +00:00
2020-09-29 15:40:17 +00:00
```sh
brew install deno
```
2019-02-20 04:25:52 +00:00
2020-09-29 15:40:17 +00:00
[Chocolatey](https://chocolatey.org/packages/deno) (Windows):
```powershell
choco install deno
```
Build and install from source using [Cargo](https://crates.io/crates/deno):
```sh
cargo install deno
```
See
[deno_install](https://github.com/denoland/deno_install/blob/master/README.md)
and [releases](https://github.com/denoland/deno/releases) for other options.
### Getting Started
Try running a simple program:
```sh
deno run https://deno.land/std/examples/welcome.ts
```
Or a more complex one:
```sh
import { serve } from "https://deno.land/std@$STD_VERSION/http/server.ts";
2020-09-29 15:40:17 +00:00
const s = serve({ port: 8000 });
console.log("http://localhost:8000/");
for await (const req of s) {
req.respond({ body: "Hello World\n" });
}
```
You can find a more in depth introduction, examples, and environment setup
guides in the [manual](https://deno.land/manual).
More in-depth info can be found in the runtime [documentation](doc.deno.land).
2020-09-29 15:40:17 +00:00
### Contributing
We appreciate your help!
To contribute, please read the our
[guidelines](https://github.com/denoland/deno/blob/master/docs/contributing/style_guide.md).
2020-09-29 15:40:17 +00:00
[Build Status - Cirrus]: https://github.com/denoland/deno/workflows/ci/badge.svg?branch=master&event=push
[Build status]: https://github.com/denoland/deno/actions
[Twitter badge]: https://twitter.com/intent/follow?screen_name=deno_land
[Twitter handle]: https://img.shields.io/twitter/follow/deno_land.svg?style=social&label=Follow