Skip to content
This repository was archived by the owner on Jul 6, 2025. It is now read-only.

Commit 12d136c

Browse files
authored
Merge pull request #1 from alephjs/master
Refresh from alephjs/aleph.js
2 parents 5e8557a + aa5c9ef commit 12d136c

File tree

205 files changed

+15250
-22310
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

205 files changed

+15250
-22310
lines changed

.editorconfig

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
root = true
4+
5+
[*.{ts,tsx}]
6+
end_of_line = lf
7+
insert_final_newline = true
8+
indent_style = space
9+
indent_size = 2

.github/workflows/aleph_in_deno.yml

Lines changed: 0 additions & 39 deletions
This file was deleted.

.github/workflows/testing.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Aleph.js Testing
2+
3+
on:
4+
push:
5+
branches: [master]
6+
pull_request:
7+
branches: [master]
8+
9+
jobs:
10+
test:
11+
runs-on: ${{ matrix.os }}
12+
13+
strategy:
14+
matrix:
15+
os: [macOS-latest, windows-latest, ubuntu-latest]
16+
17+
steps:
18+
- name: Checkout
19+
uses: actions/checkout@v2
20+
21+
- name: Setup deno
22+
uses: denolib/setup-deno@v2
23+
with:
24+
deno-version: v1.x
25+
26+
- name: Setup rust
27+
uses: hecrj/setup-rust-action@v1
28+
with:
29+
rust-version: stable
30+
31+
- name: Setup wasm-pack
32+
uses: jetli/[email protected]
33+
with:
34+
version: latest
35+
36+
- name: Deno test
37+
run: deno test -A --unstable --import-map=import_map.json --location=https://deno.land/x/aleph
38+
39+
- name: Cargo test
40+
run: cd compiler && cargo test --all

.gitignore

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
.DS_Store
2+
.env
3+
.env.*
24
Thumbs.db
3-
.aleph/
4-
dist/
5+
compiler/target/
6+
compiler/pkg/
7+
examples/**/.aleph/
8+
examples/**/dist/

.vscode/extensions.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{
22
"recommendations": [
3-
"denoland.vscode-deno"
3+
"editorconfig.editorconfig",
4+
"denoland.vscode-deno",
5+
"rust-lang.rust"
46
]
57
}

.vscode/settings.json

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,31 @@
11
{
2-
"files.eol": "\n",
3-
"files.trimTrailingWhitespace": true,
4-
"files.exclude": {
5-
"**/.git": true,
6-
"**/.DS_Store": true,
7-
"**/Thumbs.db": true
8-
},
9-
"[javascript]": {
10-
"editor.defaultFormatter": "vscode.typescript-language-features"
11-
},
12-
"[typescript]": {
13-
"editor.defaultFormatter": "vscode.typescript-language-features",
14-
"editor.formatOnSave": true,
15-
"editor.formatOnPaste": true,
16-
"editor.codeActionsOnSave": {
17-
"source.organizeImports": true,
18-
}
19-
},
20-
"deno.enable": true,
21-
"deno.unstable": true,
22-
"deno.import_map": "./import_map.json",
23-
"deno.import_intellisense_autodiscovery": true,
24-
"deno.import_intellisense_origins": {
25-
"https://deno.land": true,
26-
"https://esm.sh": true,
2+
"files.eol": "\n",
3+
"files.trimTrailingWhitespace": true,
4+
"typescript.format.semicolons": "remove",
5+
"typescript.preferences.quoteStyle": "single",
6+
"[javascript]": {
7+
"editor.defaultFormatter": "vscode.typescript-language-features",
8+
"editor.formatOnSave": false,
9+
},
10+
"[typescript]": {
11+
"editor.defaultFormatter": "vscode.typescript-language-features",
12+
"editor.formatOnSave": true,
13+
"editor.codeActionsOnSave": {
14+
"source.organizeImports": true,
2715
}
16+
},
17+
"[typescriptreact]": {
18+
"editor.defaultFormatter": "vscode.typescript-language-features",
19+
"editor.formatOnSave": true,
20+
"editor.codeActionsOnSave": {
21+
"source.organizeImports": true,
22+
}
23+
},
24+
"[rust]": {
25+
"editor.defaultFormatter": "rust-lang.rust",
26+
"editor.formatOnSave": true,
27+
},
28+
"deno.enable": true,
29+
"deno.unstable": true,
30+
"deno.importMap": "./import_map.json"
2831
}

CONTRIBUTING.md

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,52 @@
11
# Contributing to Aleph.js
22

3-
Welcome, and thank you for taking time in contributing to Aleph.js!
3+
Welcome, and thank you for taking time in contributing to Aleph.js! You can improve Aleph.js in different ways:
44

5-
## Code of Conduct
6-
7-
All contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
5+
- ∆ add new features
6+
- ✘ bugfix
7+
- ✔︎ review code
8+
- ☇ write plugins
9+
- 𝔸 improve our [documentation](https://github.com/alephjs/alephjs.org)
810

911
## Development Setup
1012

11-
You will need [Deno](https://deno.land/) 1.5+ and [VS Code](https://code.visualstudio.com/) with [deno extension](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno).
13+
You will need [Deno](https://deno.land/) 1.8+.
1214

1315
1. Fork this repository to your own GitHub account.
1416
2. Clone the repository to your local device.
1517
3. Create a new branch `git checkout -b BRANCH_NAME`.
16-
4. Change code then run examples.
18+
4. Change code then run the examples.
19+
5. Push your branch to Github after all tests passed.
20+
6. Make a [pull request](https://github.com/alephjs/aleph.js/pulls).
21+
7. Marge to master branch by our maintainers.
1722

1823
```bash
19-
deno run -A --unstable --import-map=import_map.json cli.ts ./examples/hello-world -L debug
20-
```
24+
# ssr/development with HMR
25+
ALEPH_DEV=true deno run -A --unstable --location=http://localhost cli.ts dev ./examples/hello-world -L debug
2126

22-
## Testing
27+
# ssr/production
28+
ALEPH_DEV=true deno run -A --unstable --location=http://localhost cli.ts start ./examples/hello-world -L debug
2329

24-
Run all tests:
30+
# ssg
31+
ALEPH_DEV=true deno run -A --unstable --location=http://localhost cli.ts build ./examples/hello-world -L debug
2532

26-
```bash
27-
deno test -A --unstable
33+
# run all tests
34+
deno test -A --unstable --location=http://localhost
2835
```
2936

30-
## Contributing to Documentation
37+
## Project Structure
3138

32-
You are welcome to improve our [documentation](https://alephjs.org/docs).
39+
- **/cli** commands code
40+
- **/compiler** compiler in rust powered by swc
41+
- **/framework**
42+
- **core** framework core code
43+
- **react** framework in React
44+
- **/design** design drawings and assets
45+
- **/examples** examples
46+
- **/plugins** plugins
47+
- **/server** server code
48+
- **/shared** shared code
49+
50+
## Code of Conduct
51+
52+
All contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md).

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2020 postUI Lab.
3+
Copyright (c) 2020-2021 postUI Lab.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 26 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,26 @@
1-
![Aleph Poster](./design/poster.svg)
2-
3-
# Aleph.js
4-
5-
The React Framework in [Deno](https://deno.land), inspired by [Next.js](https://nextjs.org).
6-
<br>
7-
[Website](https://alephjs.org) | [Get Started](https://alephjs.org/docs/get-started) | [Docs](https://alephjs.org/docs) | [ESM](https://esm.sh) | [The Aleph (by Jorge Luis Borges)](http://www.phinnweb.org/links/literature/borges/aleph.html)
8-
9-
[![Aleph.js in Deno](https://github.com/postui/aleph.js/workflows/Aleph.js%20in%20Deno/badge.svg)](https://github.com/postui/aleph.js/actions?query=workflow%3A%22Aleph.js+in+Deno%22)
10-
[![nest badge](https://nest.land/badge.svg)](https://nest.land/package/aleph)
11-
[![Twitter Follow](https://img.shields.io/twitter/follow/alephjs?style=social)](https://twitter.com/intent/follow?screen_name=alephjs)
12-
13-
### Features
14-
- Zero Config
15-
- Typescript in Deno
16-
- ES Module Ready
17-
- Import Maps
18-
- HMR with Fast Refresh
19-
- File-system Routing
20-
- Markdown Page
21-
- Built-in CSS(Less) Support
22-
- SSR/SSG
23-
24-
### Installation
25-
```bash
26-
deno install -A -f -n aleph https://deno.land/x/[email protected]/cli.ts
27-
```
28-
29-
### Usage
30-
```bash
31-
# create a new app
32-
aleph init hello
33-
cd hello
34-
35-
# start the app in `development` mode
36-
aleph dev
37-
38-
# start the app in `production` mode
39-
aleph start
40-
41-
# build the app to a static site (SSG)
42-
aleph build
43-
44-
# more usages
45-
aleph -h
46-
```
47-
48-
### Documentation
49-
Please visit https://alephjs.org/docs to view the documentation.
50-
51-
### Contributing
52-
Please read the [contributing.md](CONTRIBUTING.md).
1+
[![Aleph.js: The Full-stack Framework in Deno.](./design/poster.svg)](https://alephjs.org)
2+
3+
<p>
4+
<a href="https://alephjs.org">Website</a> |
5+
<a href="https://alephjs.org/docs/get-started">Get Started</a> |
6+
<a href="https://alephjs.org/docs">Docs</a> |
7+
<a href="./CONTRIBUTING.md">Contributing</a>
8+
</p>
9+
10+
<p>
11+
<a href="https://discord.gg/pWGdS7sAqD"><img src="https://img.shields.io/discord/775256646821085215?color=%23008181&label=Chat&labelColor=%23111&logo=discord&logoColor=%23aaaaaa" alt="Chat"></a>
12+
<a href="https://twitter.com/intent/follow?screen_name=alephjs"><img src="https://img.shields.io/twitter/follow/alephjs?style=social" alt="Twitter"></a>
13+
</p>
14+
15+
<details>
16+
<summary>Boom</summary>
17+
<p>
18+
19+
```bash
20+
# get started
21+
$ deno run -A https://deno.land/x/aleph/install.ts
22+
$ aleph -h
23+
```
24+
25+
</p>
26+
</details>

0 commit comments

Comments
 (0)