https://github.com/guicaulada/webserver.io

A simple webserver with socket to get things started.
https://github.com/guicaulada/webserver.io

Last synced: 14 days ago
JSON representation

A simple webserver with socket to get things started.

• Host: GitHub
• URL: https://github.com/guicaulada/webserver.io
• Owner: guicaulada
• License: gpl-3.0
• Created: 2019-03-27T18:36:59.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T17:26:07.000Z (about 2 years ago)
• Last Synced: 2024-12-17T05:53:11.838Z (19 days ago)
• Language: JavaScript
• Size: 45.9 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# webserver.io #

**webserver.io** is a simple webserver with socket to get things started.

## Requirements

* [express](https://www.npmjs.com/package/express)

* [ws](https://www.npmjs.com/package/ws) 

* [ejs](https://www.npmjs.com/package/ejs)

## Documentation ##

### Getting Started

Install webserver.io using npm:

```bash

$ npm install webserver.io

```

You can now use webserver.io like so:

```js

const Server = require('webserver.io')

let server = new Server()

server.app.set('view engine', 'ejs')

server.app.use(express.static(path.join(__dirname, 'public')))

server.app.set('views', path.join(__dirname, 'public'))

server.app.get('/', (req, res) => {

    res.render('./index.ejs')

})

server.http.listen(4000)

console.log('Terminal listening on localhost:4000')

```

Refer to the [webserver.io examples](https://github.com/Sighmir/webserver.io/tree/master/example) for more information.  

## License ##

```

webserver.io - A simple webserver with socket to get things started.

Copyright (C) 2019  Guilherme Caulada (Sighmir)

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see .

```