Skip to content

kapilkashyap/yoda

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

yoda

A basic HTTP server made using NodeJS which is lightweight, has a small footprint yet is powerful.

Usually, you would build a Node application and use a Node framework like Express JS to build and configure a server to serve that application. It is a one-one mapping, one application, one server. On the contrary yoda is a simple HTTP webserver which allows you to host multiple front-end applications 🙂

Prerequisite

How to install

You can either clone the repository or download the archive and unzip it

Will I need to build

Nope! This application does not have any npm dependencies and is ready to use OOTB 😎

How to use

Open your favourite CLI pointing to the root of the application and execute node .\server.js

Who should use this

Anyone trying to make a front-end application (ReactJS/Angular/HTML/CSS/JS/JSON/Images)

Where to deploy applications

By default, you can create/deploy your application under webapps directory. However, this can be changed in the config.json

Configurations

Property Default
base /webapps (required)
host localhost (default)
-h Command line property to pass a host name
port 3333 (default)
-p Command line property to pass a port
deploy /examples (default, this allows you to have more than one deployment directory)
-d Command line property to pass a deployment directory
info false (set to true to display server configuration details, false by default)
-i Command line property to enable showing server configuration on console
ignore { directories: Array of directories that can be ignored }
imageTypeExtensions Array of various type extensions for image files that are allowed to be served

Why to use

It's quick, simple and lightweight 😉

License

MIT Licensed

Copyright (C) 2020 Kapil Kashyap