WARD-SERVER

A Basic server for Ward





Report Bug
·
Request Feature

Table of Contents

* About
* Getting Started
* Prerequisites
* Installation
* Usage
* Contributing
* License
* Contact

About

A basic server using connect and server-static to serve Ward projects.

Getting Started

$3

* Node.js
* npm or Yarn (or any package manager)

$3

#### Method 1 (package manager):
1. Install ward-server
``sh

npm

npm install ward-server

Yarn

yarn add ward-server
`

#### Method 2 (git clone):
1. Clone this repository
`sh
git clone https://github.com/ward-framework/ward-server.git
`
2. Install dependencies
`sh

npm

npm install

Yarn

yarn add
`

Usage

Get your server running in 3 steps
`javascript
// Include the package
const Server = require('ward-server');

// Create a Server instance
const server = new Server({
path : "/src", // Path to your ward project directory
});

// Serve files
server.serve();
`

Contributing

This project is developed by a somewhat beginner javascript developer, help is always welcome. Do not hesitate to contribute to the project.

1. Fork the Project
2. Create your Feature or Fix Branch (git checkout -b feature/Feature or git checkout -b fix/Fix)
3. Commit your Changes (git commit -m 'Add some feature or fix')
4. Push to the Branch (git push origin feature/Feature or git push origin fix/Fix)
5. Open a Pull Request

License

ward-server is distributed under the MIT License. See LICENSE` for more information.

Contact

Colin Espinas - Website - contact@colinespinas.com

Project link: https://github.com/ColinEspinas/ward-server

Acknowledgements

* connect
* serve-static
* chalk