Skip to content

Commit a1a2fb9

Browse files
barriehadfieldgitbook-bot
authored andcommitted
GitBook: [edge] 34 pages modified
1 parent f2e5dfe commit a1a2fb9

24 files changed

Lines changed: 1216 additions & 1318 deletions

docs/README.md

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Welcome to Hyperstack!
1+
# Hyperstack
22

33
## Hyperstack
44

55
Hyperstack is a Ruby-based DSL and modern web toolkit for building spectacular, interactive web applications fast!
66

7-
+ **One language** throughout the client and server. All Ruby code is compiled by [Opal](https://opalrb.com/) into JavaScript automatically.
8-
+ Webpacker and Yarn tooling for a **modern, fast hot-reloader build environment with Ruby source maps**.
9-
+ A well documented and stable Ruby DSL for wrapping **React** and **ReactRouter** as well as **any** JavaScript library or component. No need to learn JavaScript!
10-
+ **Isomorphic Models with bi-directional data** so you can access your models as if they were on the client.
7+
* **One language** throughout the client and server. All Ruby code is compiled by [Opal](https://opalrb.com/) into JavaScript automatically.
8+
* Webpacker and Yarn tooling for a **modern, fast hot-reloader build environment with Ruby source maps**.
9+
* A well documented and stable Ruby DSL for wrapping **React** and **ReactRouter** as well as **any** JavaScript library or component. No need to learn JavaScript!
10+
* **Isomorphic Models with bi-directional data** so you can access your models as if they were on the client.
1111

1212
All that means you can write simple front-end code like this:
1313

@@ -21,28 +21,27 @@ class GoodBooksToRead < Hyperstack::Component
2121
end
2222
```
2323

24-
In the code above, if the `good_books` scope changed (even on the server), the UI would update automatically. That's the magic of React and Isomorphic Models with bi-directional data at work!
24+
In the code above, if the `good_books` scope changed \(even on the server\), the UI would update automatically. That's the magic of React and Isomorphic Models with bi-directional data at work!
2525

2626
## Website and documentation
2727

28-
+ Website: [hyperstack.org](https://hyperstack.org)
28+
* Website: [hyperstack.org](https://hyperstack.org)
2929

3030
Our website serves as a Hyperstack example application. All the doc content is loaded dynamically from this repo and converted to HTML on the fly. It uses React Semantic UI and a client-side JavaScript full-text search engine. Its a Rails app hosted on Heroku.
3131

3232
## Setup and installation
3333

3434
You can be up and running in **less than 5 minutes**. Just follow the simple setup guide for a new Rails application all correctly configured and ready to go with Hyperstack.
3535

36-
+ Setup and Installation: https://hyperstack.org/edge/docs/installation
36+
* Setup and Installation: [https://hyperstack.org/edge/docs/installation](https://hyperstack.org/edge/docs/installation)
3737

38-
Beyond the installation we strongly suggest new developers work trough the [todo tutorial](https://hyperstack.org/edge/docs/tutorials/todo).
39-
As it gives a minimal understanding of the Hyperstack framework.
38+
Beyond the installation we strongly suggest new developers work trough the [todo tutorial](https://hyperstack.org/edge/docs/tutorials/todo). As it gives a minimal understanding of the Hyperstack framework.
4039

4140
## Community and support
4241

4342
Hyperstack is supported by a friendly, helpful community, both for users, and contributors. We welcome new people, please reach out and say hello.
4443

45-
+ Reach us at: [Slack chat](https://hyperstack.org/slack-invite)
44+
* Reach us at: [Slack chat](https://hyperstack.org/slack-invite)
4645

4746
## Roadmap
4847

@@ -55,17 +54,14 @@ Please see the [ROADMAP](https://github.com/hyperstack-org/hyperstack/blob/edge/
5554
In general, if you would like to help in any way, please read the [CONTRIBUTING](https://github.com/hyperstack-org/hyperstack/blob/edge/CONTRIBUTING.md) file for suggestions.
5655
System setup for the development of Hyperstack itself is documented in this file.
5756

58-
More specifically, we have a [Feature Matrix](https://github.com/hyperstack-org/hyperstack/blob/edge/docs/feature_matrix.md) that needs to be filled with missing features.
59-
The idea is that you can check here what the implementation status is of a Ruby (on Rails) feature.
60-
And if you have the time and skill you're more then encouraged to implement or fix one or two.
61-
But if you're not in a position to contribute code, just expanding and maintaining this table would be excellent.
57+
More specifically, we have a [Feature Matrix](https://github.com/hyperstack-org/hyperstack/blob/edge/docs/feature_matrix.md) that needs to be filled with missing features. The idea is that you can check here what the implementation status is of a Ruby \(on Rails\) feature. And if you have the time and skill you're more then encouraged to implement or fix one or two. But if you're not in a position to contribute code, just expanding and maintaining this table would be excellent.
6258

6359
## Links
6460

65-
+ Rubygems: https://rubygems.org/profiles/hyperstack
66-
+ Travis: https://travis-ci.org/hyperstack-org
67-
+ Website edge: https://edge.hyperstack.org/
68-
+ Website master: https://hyperstack.org/
61+
* Rubygems: [https://rubygems.org/profiles/hyperstack](https://rubygems.org/profiles/hyperstack)
62+
* Travis: [https://travis-ci.org/hyperstack-org](https://travis-ci.org/hyperstack-org)
63+
* Website edge: [https://edge.hyperstack.org/](https://edge.hyperstack.org/)
64+
* Website master: [https://hyperstack.org/](https://hyperstack.org/)
6965

7066
## License
7167

@@ -76,7 +72,8 @@ Hyperstack is developed and released under the MIT License. See the [LICENSE](ht
7672
Hyperstack is an evolution of [Ruby-Hyperloop](https://github.com/ruby-hyperloop). We decided to rename the project to drop the Ruby suffix and also took the opportunity to simplify the repos and project overall.
7773
Hyperloop was started by the developers of the reactrb gem.
7874

79-
+ Old website: http://ruby-hyperloop.org/
80-
+ Old Github: https://github.com/ruby-hyperloop
81-
+ Legacy branch: https://github.com/hyperstack-org/hyperstack/tree/hyperloop-legacy
82-
+ Legacy install script: https://github.com/hyperstack-org/hyperstack/tree/hyperloop-legacy/install
75+
* Old website: [http://ruby-hyperloop.org/](http://ruby-hyperloop.org/)
76+
* Old Github: [https://github.com/ruby-hyperloop](https://github.com/ruby-hyperloop)
77+
* Legacy branch: [https://github.com/hyperstack-org/hyperstack/tree/hyperloop-legacy](https://github.com/hyperstack-org/hyperstack/tree/hyperloop-legacy)
78+
* Legacy install script: [https://github.com/hyperstack-org/hyperstack/tree/hyperloop-legacy/install](https://github.com/hyperstack-org/hyperstack/tree/hyperloop-legacy/install)
79+

docs/SUMMARY.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Table of contents
22

3-
* [Welcome to Hyperstack!](README.md)
3+
* [Hyperstack](README.md)
44
* [Installation](installation/README.md)
55
* [Installation](installation/man-installation.md)
66
* [Configuration](installation/config.md)
@@ -9,18 +9,18 @@
99
* [TodoMVC Tutorial Part I](tutorial/todo.md)
1010
* [TodoMVC Tutorial Part II](tutorial/todo-part-2.md)
1111
* [Community](community.md)
12-
* [Client DSL](dsl-client/README.md)
13-
* [HTML and Component DSL](dsl-client/hyper-component.md)
14-
* [Client-side Routing](dsl-client/hyper-router.md)
15-
* [Stores](dsl-client/hyper-store.md)
16-
* [Isomorphic DSL](dsl-isomorphic/README.md)
17-
* [Isomorphic Models](dsl-isomorphic/hyper-model.md)
18-
* [Isomorphic Operations](dsl-isomorphic/hyper-operation.md)
19-
* [Policies](dsl-isomorphic/hyper-policy.md)
20-
* [Development Workflow](tools/README.md)
21-
* [Debugging](tools/debugging.md)
22-
* [Internationalization](tools/hyper-i18n.md)
23-
* [HyperSpec](tools/hyper-spec.md)
24-
* [Tools](tools/tools.md)
12+
* [Client DSL](client-dsl/README.md)
13+
* [HTML and Component DSL](client-dsl/hyper-component.md)
14+
* [Client-side Routing](client-dsl/hyper-router.md)
15+
* [Stores](client-dsl/hyper-store.md)
16+
* [Isomorphic DSL](isomorphic-dsl/README.md)
17+
* [Isomorphic Models](isomorphic-dsl/hyper-model.md)
18+
* [Isomorphic Operations](isomorphic-dsl/hyper-operation.md)
19+
* [Policies](isomorphic-dsl/hyper-policy.md)
20+
* [Development Workflow](development-workflow/README.md)
21+
* [Debugging](development-workflow/debugging.md)
22+
* [Internationalization](development-workflow/hyper-i18n.md)
23+
* [HyperSpec](development-workflow/hyper-spec.md)
24+
* [Tools](development-workflow/tools.md)
2525
* [Feature Matrix](feature_matrix.md)
2626

docs/client-dsl/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Client DSL
2+

0 commit comments

Comments
 (0)