Get Started
Welcome to Aleph.js!
Prerequisites
- Deno 1.7+
- VS Code with deno extension (recommended)
Installation
$ deno install -A -f -n aleph https://deno.land/x/aleph@v0.3.0-alpha.1/cli.ts
Usage
Create a new app:
$ aleph init hello
$ cd hello
Start the app in development
mode:
$ aleph dev
This starts the development server on http://localhost:8080.
Visit http://localhost:8080 to view your application.
Server features:
- Compile modules(
js,jsx,ts,tsx,md,css,less...
) and manage deps - HMR With React Fast Refresh
- Serve APIs from
./api/
- Server-side rendering of
./pages/
- Serve Static files from
./public/
(mapped to/
)
Start the app in production
mode:
$ aleph start
The application will start at http://localhost:8080 by default.
The default port can be changed with -p
(or --port
).
Build the app to a static site(SSG):
$ aleph build
This will export a static site in the output
directory, which can be run standalone on any server.
See the hello-world example on Vercel.
More usages:
$ aleph -h