Stevo NPM | npm.io

stevo

Quick and easy web framework.

Get a server up and running in one line.

require('stevo').createServer('PokemonShowdown');

Installation

npm install stevo

Getting Started

Install Node.js on your computer. stevo is installed and run using a command line. In Windows, open Command Prompt (type cmd into the Start menu and it should be the first result). In Mac OS X, open Terminal (it's in Utilities). Type this into the command line:

$ npm install stevo

Then create a file in a text editor and save it as app.js. Type this in it (Don't type the lines with the //):

// app.js
var stevo = require('stevo');

// Create a Pokemon Showdown server and add yourself as admin.
stevo.createServer('ps', {
  owner: 'Your Pokemon Showdown Username here'
});

Save this file and then go back to the command line and type this to start up the server:

$ node app.js

Open up your browser and go to http://localhost:8000 to go on your server locally.

Documentation

createServer(type, options)

Create a new server depending on types with configurations from the options.

Arguments

type - An string that determines what type of server is created.
options - A object that sets the configuration of the server.

Examples

// Simple Http Server
stevo.createServer('http', { port: 8080 });

// Pokemon Showdown Server
stevo.createServer('http', { owner: 'CreaturePhil', config: { port: 3000 } });

Simple Http Server

stevo.createServer('simpleHttpServer', {
  port: 3000,       // Set the port
  logging: true     // module `morgan` logging
});

Sets up a Simple Http Server using express. Sends all files starting at root of your project. Index route (/) sends index.html by default. Alternative type is http.

Pokemon Showdown

stevo.createServer('PokemonShowdown', {
  owner: 'CreaturePhil',
  config: {
    port: 3000,
    reportbattles: false
  },
  commands: {
    yo: function(target, room, user, connection, cmd) {
      this.sendReply('yo');
    }
  }
});

Sets up a Pokemon-Showdown server. Default port is 3000.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Code Style

This project uses Airbnb JavaScript Style Guide with a few minor exceptions. If you are submitting a pull request that involves Jade templates, please make sure you are using spaces, not tabs.