Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/epeios-q37/atlas-node

World's lightest toolkit to quickly and easily add a GUI to your Node programs and bring them online.
https://github.com/epeios-q37/atlas-node

api gui javascript network node node-js node-module nodejs repl todomvc web

Last synced: about 1 month ago
JSON representation

World's lightest toolkit to quickly and easily add a GUI to your Node programs and bring them online.

Host: GitHub
URL: https://github.com/epeios-q37/atlas-node
Owner: epeios-q37
License: mit
Created: 2018-11-18T07:31:04.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-01-27T15:40:57.000Z (10 months ago)
Last Synced: 2024-10-04T00:45:17.890Z (about 1 month ago)
Topics: api, gui, javascript, network, node, node-js, node-module, nodejs, repl, todomvc, web
Language: JavaScript
Homepage: http://atlastk.org
Size: 341 KB
Stars: 4
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        


The *Atlas* toolkit is available for:

[![Java](https://s.q37.info/jrnv4mj4.svg)](https://github.com/epeios-q37/atlas-java) [![Node.js](https://s.q37.info/fh7v7kn9.svg)](https://github.com/epeios-q37/atlas-node) [![Perl](https://s.q37.info/hgnwnnn3.svg)](https://github.com/epeios-q37/atlas-perl) [![Python](https://s.q37.info/94937nbb.svg)](https://github.com/epeios-q37/atlas-python) [![Ruby](https://s.q37.info/zn4qrx9j.svg)](https://github.com/epeios-q37/atlas-ruby)

To see the *Atlas* toolkit in action:

[![Version 0.13](https://img.shields.io/static/v1.svg?&color=blue&labelColor=red&label=online&message=demonstrations&style=for-the-badge)](https://s.q37.info/sssznrb4)



# *Node.js* version of the *Atlas* toolkit



[![Version 0.13](https://img.shields.io/static/v1.svg?&color=90b4ed&label=Version&message=0.13&style=for-the-badge)](http://github.com/epeios-q37/atlas-node/) [![license: MIT](https://img.shields.io/github/license/epeios-q37/atlas-node?color=yellow&style=for-the-badge)](https://github.com/epeios-q37/atlas-node/blob/master/LICENSE) [![Documentation](https://img.shields.io/static/v1?label=documentation&message=atlastk.org&color=ff69b4&style=for-the-badge)](https://atlastk.org) [![Version](https://img.shields.io/npm/v/atlastk?style=for-the-badge)](https://s.q37.info/h3zjb39j)



## A GUI with *Node.js* in a couple of minutes

Click the animation to see a screencast of programming this ["Hello, World!" program](https://en.wikipedia.org/wiki/%22Hello,_World!%22_program) with *Node.js* in a matter of minutes:



[![Building a GUI in with *Node.js* in less then 10 minutes](https://s.q37.info/qp4z37pg.gif)](https://s.q37.info/4pcpvrhz)



Same video on [*Peertube*](https://en.wikipedia.org/wiki/PeerTube): .

Click to see the corresponding source code

```javascript

const atlastk = require('atlastk');

 

const BODY = `

 

 Hello

 


 

  Greetings displayed here!

 

`;

 

const CALLBACKS = {

 "": (dom, id) => dom.inner("", BODY,

  () => dom.focus("Input")),

 "Submit": (dom, id) => dom.getValue("Input",

  (name) => dom.begin("Output", "
Hello, " + name + "!",

   () => dom.setValue("Input", "",

    () => dom.focus("Input")))),

};

 

atlastk.launch(() => new atlastk.DOM(), CALLBACKS);

```

### See for yourself right now - it's quick and easy!

```shell

# You can replace 'github.com' with 'framagit.org'.

# DON'T copy/paste this and above line!

git clone https://github.com/epeios-q37/atlas-node

cd atlas-node

npm install

cd examples

node Hello/main.js

```

## Your turn

If you want to take your code to the next level, from [CLI](https://s.q37.info/cnh9nrw9) to [GUI](https://s.q37.info/hw9n3pjs), then you found the right toolkit.

With the [*Atlas* toolkit](http://atlastk.org/), you transform your programs in modern web applications ([*SPA*](https://s.q37.info/7sbmxd3j)) without the usual hassles:

- no front-end *JavaScript* to write; only *HTML*(/*CSS*) and *Node.js*,

- no [front and back end architecture](https://s.q37.info/px7hhztd) to bother with,

- no [web server](https://s.q37.info/n3hpwsht) (*Apache*, *Nginx*…) to install,

- no need to deploy your application on a remote server,

- no incoming port to open on your internet box or routeur.

The *Atlas* toolkit is written in pure *Node.js*, with no native code and no dependencies, allowing the *Atlas* toolkit to be used on all environments where *Node.js* is available. 

And simply by running them on a local computer connected to internet, applications using the *Atlas* toolkit will be accessible from the entire internet on laptops, smartphones, tablets…

## Content of the repository

The `atlastk` directory contains the *JavaScript* source code for *Node.js* of the *Atlas* toolkit, which is not needed to run the examples.

The `node_modules` directory (not provided by the repository, but will be created when launching `npm install`) contains the files that are needed in order to use the *Atlas* toolkit.

The `examples` directory contains some examples.

To launch an example (from within the repository):

- launch `npm install` (this have only to be do once),

- `cd examples`,

- launch `node /main.js`,

where `` is the name of the example (`15-puzzle`, `Blank`, `Chatroom`…). For example `node Hello/main.js`.