Skip to content
Snippets Groups Projects
README.md 2.84 KiB

Swerve

Quick and easy multithreaded file server for local development

About

A common misconception about swerve is that the name is a play on the word "serve", as in the purpose of a file server. Contrary to this, swerve actually stands for "Simple Werve" - the goal being to make it super simple to werve your files from anywhere on the filesystem.

While swerve does nothing innovative, the goal is to have a fast performing file server with minimal set up and tear down time, as well as minimal request time spent inside the server itself. Current features are limited to serving files, but the roadmap includes API mocking to make front end development even easier.

##Installation

Prebuilt

  1. Download the binary for your OS from the releases page
  2. Put swerve somewhere in your $PATH, or modify your $PATH to inlcude the folder containing swerve
  3. Do one of two things:
    1. Open up a command prompt and cd to the folder containing your files and run swerve
      cd "$HOME/projects/my_awesome_site"
      swerve
    2. Open up a command prompt and run swerve, specifying your target directory
      swerve -d "$HOME/projects/my_awesome_site"

From source

To build and install swerve from source, you will need rustc 1.22.0-nightly or later as well as the Cargo package manager