Code Monkey home page Code Monkey logo

servez's Introduction

Servez

A simple web server for local web development.

screenshow

Download

Click Here

Choose the .dmg for mac, the .exe for Windows, or the .AppImage for Linux.

What?

Servez is an stand alone app that runs a simple web server. with a GUI to start/stop and choose a folder to serve.

I've worked with many people, often students, who are not comfortable with command lines and certainly not comfortable setting up a big server like Apache.

Servez provides them with an easy way to get started without having to install multiple dependencies nor having to integrate things with their system. No adding to paths, no downloading 3 different pieces of software. Just run and start.

HTTPS

Servez has an option to serve HTTPS. Servez uses a self signed certificate which means your browser will complain that the certificate is not valid. You can click "advanced" on the warning page and then "Proceed to <localhost>" to load the page.

The point of HTTPS support in Servez is to make it easy to access HTTPS only APIs like WebXR etc... Clicking through a warning once in a while is a small tradeoff for automating HTTPS support.

Command Line Arguments

If you want an actual command line version then go here.

Otherwise these are the command line arguments to this app version of Servez.

NOTE! You must include an extra -- by itself before your arguments

servez.exe --port=1234 c:\path\to\serve      # BAD!
servez.exe -- --port=1234 c:\path\to\serve   # good

On Windows the default path is

c:\Users\<username>\AppData\Local\Programs\Servez\Servez.exe

on MacOS the default path is

/Applications/Servez.app/Contents/MacOS/Servez

Usage

servez [options] path/to/serve
  • --help prints the command line arguments

  • -p or --port sets the port as in --port=1234

  • --ssl use HTTPS (see above)

  • --no-dirs don't show directory listings for folders

  • --no-cors don't supply CORS headers

  • --local only allow access from local machine

  • --no-index don't serve index.html for folders

Development

Setup

  • Install node.js

    You can download it here.

  • clone this repo

    git clone https://github.com/greggman/servez.git
    
  • change to the project's folder

    cd servez
    
  • install dependencies

    npm install
    

Organization

main.js          // runs the browser process
src/index.html   // the main window
src/index.js     // JS for the main window
src/style.css    // CSS for the main window

Running

npm start

Will launch with devtools open. Setting the environment variable SERVEZ_ECHO to true will make issue many logging commands in main.js into the log in the app

Building

npm run dist

Will build a file for distribution in the dist folder for the current platform.

servez's People

Contributors

greggman avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.