foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-31 11:34:15 -05:00
Code Issues Packages 1 Wiki Activity

web design (#1655)

Browse source
This commit is contained in:
Ryan Dahl 2019-02-02 18:40:18 -05:00 committed by GitHub
parent efa1eeb8b3
commit 1d48e025d3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 293 additions and 200 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

168
Docs.md
View file

@ -19,7 +19,7 @@ scripts to download and install the binary.
Using Shell: Using Shell:
``` ```
curl -L https://deno.land/x/install/install.sh | sh curl -fL https://deno.land/x/install/install.sh | sh
``` ```
Or using PowerShell: Or using PowerShell:
@ -63,6 +63,88 @@ Or see the [doc website](https://deno.land/typedoc/index.html).
If you are embedding deno in a Rust program, see If you are embedding deno in a Rust program, see
[the rust docs](https://deno.land/rustdoc/deno/index.html). [the rust docs](https://deno.land/rustdoc/deno/index.html).
## Build Instructions
### Prerequisites:
To ensure reproducible builds, deno has most of its dependencies in a git
submodule. However, you need to install separately:
1. [Rust](https://www.rust-lang.org/en-US/install.html) >= 1.31.1
2. [Node](https://nodejs.org/)
3. Python 2.
[Not 3](https://github.com/denoland/deno/issues/464#issuecomment-411795578).
Extra steps for Mac users:
1. [XCode](https://developer.apple.com/xcode/)
2. Openssl 1.1: `brew install openssl@1.1` (TODO: shouldn't be necessary)
Extra steps for Windows users:
1. Add `python.exe` to `PATH` (e.g. `set PATH=%PATH%;C:\Python27\python.exe`)
2. Get [VS Community 2017](https://www.visualstudio.com/downloads/) with
`Desktop development with C++` toolkit and make sure to select the following
required tools listed below along with all C++ tools.
- Windows 10 SDK >= 10.0.17134
- Visual C++ ATL for x86 and x64
- Visual C++ MFC for x86 and x64
- C++ profiling tools
3. Enable `Debugging Tools for Windows`. Go to `Control Panel` → `Programs` →
`Programs and Features` → Select
`Windows Software Development Kit - Windows 10` → `Change` → `Change` → Check
`Debugging Tools For Windows` → `Change` -> `Finish`.
### Build:
# Fetch deps.
git clone --recurse-submodules https://github.com/denoland/deno.git
cd deno
./tools/setup.py
# You may need to ensure that sccache is running.
# (TODO it's unclear if this is necessary or not.)
# prebuilt/mac/sccache --start-server
# Build.
./tools/build.py
# Run.
./target/debug/deno tests/002_hello.ts
# Test.
./tools/test.py
# Format code.
deno ./tools/format.ts
Other useful commands:
# Call ninja manually.
./third_party/depot_tools/ninja -C target/debug
# Build a release binary.
DENO_BUILD_MODE=release ./tools/build.py :deno
# List executable targets.
./third_party/depot_tools/gn ls target/debug //:* --as=output --type=executable
# List build configuration.
./third_party/depot_tools/gn args target/debug/ --list
# Edit build configuration.
./third_party/depot_tools/gn args target/debug/
# Describe a target.
./third_party/depot_tools/gn desc target/debug/ :deno
./third_party/depot_tools/gn help
# Update third_party modules
git submodule update
Environment variables: `DENO_BUILD_MODE`, `DENO_BUILD_PATH`, `DENO_BUILD_ARGS`,
`DENO_DIR`.
## Tutorial ## Tutorial
### An implementation of the unix "cat" program ### An implementation of the unix "cat" program
@ -306,90 +388,6 @@ Current executable set to '../deno/target/debug/deno' (x86_64).
(lldb) r (lldb) r
``` ```
## Build Instructions _(for advanced users only)_
### Prerequisites:
To ensure reproducible builds, deno has most of its dependencies in a git
submodule. However, you need to install separately:
1. [Rust](https://www.rust-lang.org/en-US/install.html) >= 1.31.1
2. [Node](https://nodejs.org/)
3. Python 2.
[Not 3](https://github.com/denoland/deno/issues/464#issuecomment-411795578).
4. [ccache](https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/ccache)
(Optional but helpful for speeding up rebuilds of V8.)
Extra steps for Mac users:
1. [XCode](https://developer.apple.com/xcode/)
2. Openssl 1.1: `brew install openssl@1.1` (TODO: shouldn't be necessary)
Extra steps for Windows users:
1. Add `python.exe` to `PATH` (e.g. `set PATH=%PATH%;C:\Python27\python.exe`)
2. Get [VS Community 2017](https://www.visualstudio.com/downloads/) with
`Desktop development with C++` toolkit and make sure to select the following
required tools listed below along with all C++ tools.
- Windows 10 SDK >= 10.0.17134
- Visual C++ ATL for x86 and x64
- Visual C++ MFC for x86 and x64
- C++ profiling tools
3. Enable `Debugging Tools for Windows`. Go to `Control Panel` → `Programs` →
`Programs and Features` → Select
`Windows Software Development Kit - Windows 10` → `Change` → `Change` → Check
`Debugging Tools For Windows` → `Change` -> `Finish`.
### Build:
# Fetch deps.
git clone --recurse-submodules https://github.com/denoland/deno.git
cd deno
./tools/setup.py
# You may need to ensure that sccache is running.
# (TODO it's unclear if this is necessary or not.)
# prebuilt/mac/sccache --start-server
# Build.
./tools/build.py
# Run.
./target/debug/deno tests/002_hello.ts
# Test.
./tools/test.py
# Format code.
deno ./tools/format.ts
Other useful commands:
# Call ninja manually.
./third_party/depot_tools/ninja -C target/debug
# Build a release binary.
DENO_BUILD_MODE=release ./tools/build.py :deno
# List executable targets.
./third_party/depot_tools/gn ls target/debug //:* --as=output --type=executable
# List build configuration.
./third_party/depot_tools/gn args target/debug/ --list
# Edit build configuration.
./third_party/depot_tools/gn args target/debug/
# Describe a target.
./third_party/depot_tools/gn desc target/debug/ :deno
./third_party/depot_tools/gn help
# Update third_party modules
git submodule update
Environment variables: `DENO_BUILD_MODE`, `DENO_BUILD_PATH`, `DENO_BUILD_ARGS`,
`DENO_DIR`.
## Internals ## Internals
### Internal: libdeno API. ### Internal: libdeno API.

323
website/index.html
View file

@ -1,151 +1,246 @@
<!-- Copyright 2018-2019 the Deno authors. All rights reserved. MIT license. --> <!-- Copyright 2018-2019 the Deno authors. All rights reserved. MIT license. -->
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
<head> <head>
<title>Deno</title> <title>Deno</title>
<link rel="manifest" href="/manifest.json"> <link rel="manifest" href="/manifest.json" />
<link rel="stylesheet" href="https://unpkg.com/c3@0.6.7/c3.min.css"> <link rel="stylesheet" href="https://unpkg.com/c3@0.6.7/c3.min.css" />
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css" />
<meta content='width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0' name='viewport' /> <meta
</head> content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"
<body> name="viewport"
<main> />
<img src="deno_logo_2.gif" width=150 /> </head>
<!-- Logo animation by hashrock --> <body>
<main>
<img id="logo" src="deno_logo_2.gif" width="150" />
<!-- Logo by hashrock https://denolib.github.io/animated-deno-logo/ -->
<h1>Deno</h1> <h1>Deno</h1>
<table> <p>
<tr> A new way to JavaScript
<th>Linux &amp; Mac</th>
<th>Windows</th>
</tr>
<tr>
<td>
<a class="badge" href="https://travis-ci.com/denoland/deno"><img src="https://travis-ci.com/denoland/deno.svg?branch=master"/></a>
</td>
<td>
<a class="badge" href="https://ci.appveyor.com/project/deno/deno"><img src="https://ci.appveyor.com/api/projects/status/yel7wtcqwoy0to8x/branch/master?svg=true"/></a>
</td>
</tr>
</table>
<p>A new way to JavaScript <!-- TODO(ry) add the registry badges. -->
</p>
<p> <a href="https://github.com/denoland/deno">github.com/denoland/deno</a> <table>
<tr>
<th></th>
<th>Linux &amp; Mac</th>
<th>Windows</th>
</tr>
<tr>
<th><a href="https://github.com/denoland/deno">deno</a></th>
<td>
<a class="badge" href="https://travis-ci.com/denoland/deno"
><img src="https://travis-ci.com/denoland/deno.svg?branch=master"
/></a>
</td>
<td>
<a class="badge" href="https://ci.appveyor.com/project/deno/deno"
><img
src="https://ci.appveyor.com/api/projects/status/yel7wtcqwoy0to8x/branch/master?svg=true"
/></a>
</td>
</tr>
<tr>
<th><a href="https://github.com/denoland/deno_std">deno_std</a></th>
<td colspan="2">
<a
class="badge"
href="https://dev.azure.com/denoland/deno_std/_build?definitionId=2"
><img
src="https://dev.azure.com/denoland/deno_std/_apis/build/status/denoland.deno_std?branchName=master"
/></a>
</td>
</tr>
<tr>
<th>
<a href="https://github.com/denoland/deno_install">deno_install</a>
</th>
<td>
<a class="badge" href="https://travis-ci.com/denoland/deno_install"
><img
src="https://travis-ci.com/denoland/deno_install.svg?branch=master"
/></a>
</td>
<td>
<a
class="badge"
href="https://ci.appveyor.com/project/deno/deno-install"
><img
src="https://ci.appveyor.com/api/projects/status/gtekeaf7r60xa896?branch=master&svg=true"
/></a>
</td>
</tr>
<tr>
<th><a href="https://github.com/denoland/registry">registry</a></th>
</tr>
</table>
<p><a href="https://github.com/denoland/deno_std">github.com/denoland/deno_std</a> <p>
<a href="https://github.com/denoland/deno/blob/master/Docs.md"
>Documentation</a
>
</p>
<p><a href="https://github.com/denoland/deno_install">github.com/denoland/deno_install</a> <p><a href="typedoc/index.html">API Reference</a></p>
<p><a href="https://github.com/denoland/registry">github.com/denoland/registry</a> <p>
<a href="https://github.com/denolib/awesome-deno"
>Other Deno resources.</a
>
</p>
<p> <a href="https://github.com/denoland/deno/blob/master/Docs.md">Documentation</a> <h2>Install</h2>
<p> <a href="typedoc/index.html">API Reference</a> <p>With Shell</p>
<pre>
<p><a href="https://github.com/denolib/awesome-deno">Links to other Deno resources.</a> curl -fL https://deno.land/x/install/install.sh | sh
</pre
<h2>Getting started</h2> >
<p>With PowerShell</p>
<p>Install Deno into ~/.deno/bin <pre>
<h2>With Shell</h2>
<pre>
curl -L https://deno.land/x/install/install.sh | sh
export PATH=$HOME/.deno/bin:$PATH
</pre>
<h2>With PowerShell</h2>
<pre>
iex (iwr https://deno.land/x/install/install.ps1) iex (iwr https://deno.land/x/install/install.ps1)
</pre> </pre
>
Try a Deno program. Install by bash alias. <h2>Mini-tutorial</h2>
This one serves a local directory in HTTP.
<pre> Try a Deno program. This one serves a local directory in HTTP.
<pre>
alias file_server="deno \ alias file_server="deno \
https://deno.land/x/http/file_server.ts --allow-net" https://deno.land/x/http/file_server.ts --allow-net"
</pre> </pre
>
Run it: Run it:
<pre> <pre>
% file_server . % file_server .
Downloading https://deno.land/x/http/file_server.ts... Downloading https://deno.land/x/http/file_server.ts...
[...] [...]
HTTP server listening on http://0.0.0.0:4500/ HTTP server listening on http://0.0.0.0:4500/
</pre> </pre
>
And if you ever want to upgrade to the latest published version: And if you ever want to upgrade to the latest published version:
<pre> <pre>
file_server --reload file_server --reload
</pre> </pre
>
<h2>Benchmarks</h2> <h2>Dig in...</h2>
<h3>Execution time</h3> <a href="https://github.com/denoland/deno/blob/master/Docs.md"
This shows how much time total it takes to run a few simple deno programs: >Documentation</a
<a href="https://github.com/denoland/deno/blob/master/tests/002_hello.ts">tests/002_hello.ts</a> >
and
<a href="https://github.com/denoland/deno/blob/master/tests/003_relative_import.ts">tests/003_relative_import.ts</a>.
For deno to execute typescript, it must first compile it to JS.
A warm startup is when deno has a cached JS output already, so
it should be fast because it bypasses the TS compiler.
A cold startup is when deno must compile from scratch.
<div id="exec-time-chart"></div>
<h3>Throughput</h3> <p><a href="typedoc/index.html">API Reference</a></p>
Time it takes to pipe a certain amount of data through Deno.
<a href="https://github.com/denoland/deno/blob/master/tests/echo_server.ts">echo_server.ts</a>
and
<a href="https://github.com/denoland/deno/blob/master/tests/cat.ts">cat.ts</a>
Smaller is better.
<div id="throughput-chart"></div> <p>
<a href="https://github.com/denolib/awesome-deno"
>Links to other Deno resources.</a
>
</p>
<h3>Req/Sec</h3> <h2>Continuous Benchmarks</h2>
Tests HTTP server performance. 10 keep-alive connections
do as many hello-world requests as possible. Bigger is better.
<ul>
<!-- TODO rename "deno" to "deno_tcp". -->
<li><a
href="https://github.com/denoland/deno/blob/master/tests/http_bench.ts">deno</a>
is a fake http server that doesn't parse HTTP. It is comparable to <a
href="https://github.com/denoland/deno/blob/master/tools/node_tcp.js">node_tcp</a>.
<li><a
href="https://github.com/denoland/deno_std/blob/master/http/http_bench.ts">deno_net_http</a>
is a web server written in TypeScript. It
is comparable to <a
href="https://github.com/denoland/deno/blob/master/tools/node_http.js">node_http</a>.
<li><a
href="https://github.com/denoland/deno/blob/master/tools/hyper_hello.rs">hyper</a>
is a Rust HTTP server and represents an upper bound.
</ul>
<div id="req-per-sec-chart"></div> These plots are updated on every commit to
<a href="https://github.com/denoland/deno">master branch</a>.
<h3>Executable size</h3> <h3>Execution time</h3>
deno ships only a single binary. We track its size here. This shows how much time total it takes to run a few simple deno programs:
<div id="binary-size-chart"></div> <a href="https://github.com/denoland/deno/blob/master/tests/002_hello.ts"
>tests/002_hello.ts</a
>
and
<a
href="https://github.com/denoland/deno/blob/master/tests/003_relative_import.ts"
>tests/003_relative_import.ts</a
>. For deno to execute typescript, it must first compile it to JS. A warm
startup is when deno has a cached JS output already, so it should be fast
because it bypasses the TS compiler. A cold startup is when deno must
compile from scratch.
<div id="exec-time-chart"></div>
<h3>Thread count</h3> <h3>Throughput</h3>
How many threads various programs use. Time it takes to pipe a certain amount of data through Deno.
<div id="thread-count-chart"></div> <a
href="https://github.com/denoland/deno/blob/master/tests/echo_server.ts"
>echo_server.ts</a
>
and
<a href="https://github.com/denoland/deno/blob/master/tests/cat.ts"
>cat.ts</a
>
Smaller is better.
<h3>Syscall count</h3> <div id="throughput-chart"></div>
How many total syscalls are performed when executing a given script.
<div id="syscall-count-chart"></div>
<h3>References</h3> <h3>Req/Sec</h3>
<p> <a href="./all_benchmark.html">All benchmark data</a> Tests HTTP server performance. 10 keep-alive connections do as many
hello-world requests as possible. Bigger is better.
<ul>
<!-- TODO rename "deno" to "deno_tcp". -->
<li>
<a
href="https://github.com/denoland/deno/blob/master/tests/http_bench.ts"
>deno</a
>
is a fake http server that doesn't parse HTTP. It is comparable to
<a
href="https://github.com/denoland/deno/blob/master/tools/node_tcp.js"
>node_tcp</a
>.
</li>
</main> <li>
<script src="https://unpkg.com/d3@5.7.0/dist/d3.min.js"></script> <a
<script src="https://unpkg.com/c3@0.6.7/c3.min.js"></script> href="https://github.com/denoland/deno_std/blob/master/http/http_bench.ts"
>deno_net_http</a
>
is a web server written in TypeScript. It is comparable to
<a
href="https://github.com/denoland/deno/blob/master/tools/node_http.js"
>node_http</a
>.
</li>
<script type="module"> <li>
import { drawCharts } from "./app.js"; <a
href="https://github.com/denoland/deno/blob/master/tools/hyper_hello.rs"
>hyper</a
>
is a Rust HTTP server and represents an upper bound.
</li>
</ul>
drawCharts("recent.json"); <div id="req-per-sec-chart"></div>
</script>
</body> <h3>Executable size</h3>
deno ships only a single binary. We track its size here.
<div id="binary-size-chart"></div>
<h3>Thread count</h3>
How many threads various programs use.
<div id="thread-count-chart"></div>
<h3>Syscall count</h3>
How many total syscalls are performed when executing a given script.
<div id="syscall-count-chart"></div>
<p><a href="./all_benchmark.html">Historical benchmark data</a></p>
</main>
<script src="https://unpkg.com/d3@5.7.0/dist/d3.min.js"></script>
<script src="https://unpkg.com/c3@0.6.7/c3.min.js"></script>
<script type="module">
import { drawCharts } from "./app.js";
drawCharts("recent.json");
</script>
</body>
</html> </html>

2
website/style.css
View file

@ -2,7 +2,7 @@
body { body {
color: #111; color: #111;
background: #f0f0f0; background: #f0f0f0;
margin: 80px 0; margin: 1em;
font-family: Arial; font-family: Arial;
font-size: 20px; font-size: 20px;
} }