aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: 376d6976e91c93ce5101e5bb54824e3882b070f4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
#+title: bom.el
#+author: Yuchen Pei <id@ypei.org>

* Introduction
  :PROPERTIES:
  :UPDATED:  [2023-10-08 Sun 15:47]
  :END:

This is a PoC experiment, demonstrating the power of emacs-web-server.

The goal is not to implement something fancy, but:

1. Banish Javascript
2. Write an emacs package, get a webapp for free

The first item is quite achievable. Regarding the second, it would be
ideal to have a package that transforms emacs packages to webapps.

So far in this experiment we have implemented a webapp only.

* Usage
  :PROPERTIES:
  :UPDATED:  [2023-10-08 Sun 15:35]
  :END:

** Serve from current emacs instance
   :PROPERTIES:
   :UPDATED:  [2023-10-08 Sun 15:39]
   :END:
Make sure =emacs-web-server= is available. It can be installed from
the GNU ELPA:

#+begin_src emacs-lisp
(package-install 'web-server)
#+end_src

Require and start the server:

#+begin_src emacs-lisp
(require 'bom)
(bom-start)
#+end_src

The weather forecast is available at <http://localhost:9000>.

** Serve as purely a webapp
   :PROPERTIES:
   :UPDATED:  [2023-10-08 Sun 15:40]
   :END:

Run ~make serve~.

* Contact and Copyright
  :PROPERTIES:
  :UPDATED:  [2023-10-08 Sun 15:42]
  :END:

=bom.el= is maintained by Yuchen Pei <id@ypei.org> and covered by [[https://www.gnu.org/licenses/agpl-3.0.en.html][GNU
AGPLv3+]]. You may find the license text in a file named COPYING.agpl3
in the project tree.