# ward-server

> A basic server for Ward

Latest version **1.1.2** (published 2020-02-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install ward-server
pnpm add ward-server
yarn add ward-server
bun add ward-server
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2020-02-03 |
| First published | 2020-01-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Colin Espinas |
| Maintainers | colin-espinas |

## Links

- npm: https://www.npmjs.com/package/ward-server
- Repository: https://github.com/ward-framework/ward-server
- Homepage: https://github.com/ward-framework/ward-server#readme
- Issues: https://github.com/ward-framework/ward-server/issues
- npm.io page: https://npm.io/package/ward-server

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [connect](https://npm.io/package/connect.md) ^3.7.0
- [serve-static](https://npm.io/package/serve-static.md) ^1.14.1

## Recent versions

- 1.1.2 (latest) — 2020-02-03
- 1.1.1 — 2020-01-05
- 1.1.0 — 2020-01-05
- 1.0.2 — 2020-01-05
- 1.0.1 — 2020-01-05

## README

<!-- PROJECT LOGO -->
<br />
<p align="center">
<!--
  <a href="https://github.com/colinespinas/ward">
    <img src="https://raw.githubusercontent.com/colinespinas/ward/master/public/assets/images/logo.png" alt="Logo" width="120">
  </a>
  -->

  <h3 align="center">WARD-SERVER</h3>

  <p align="center">
    A Basic server for <a href="https://github.com/ward-framework/ward">Ward</a>
    <br />
    <br />
    <!--<a href="https://ColinEspinas.github.io/ward/public/">View Demo</a>
    ·-->
    <a href="https://github.com/ward-framework/ward-server/issues">Report Bug</a>
    ·
    <a href="https://github.com/ward-framework/ward-server/issues">Request Feature</a>
    <br />
    <br />
    <a href="https://github.com/ward-framework/ward-server/graphs/contributors">
      <img src="https://img.shields.io/github/contributors/ward-framework/ward-server.svg?style=flat-square" alt="Contributors">
    </a>
    <a href="https://github.com/ward-framework/ward-server/network/members">
      <img src="https://img.shields.io/github/forks/ward-framework/ward-server.svg?style=flat-square" alt="Forks">
    </a>
    <a href="https://github.com/ward-framework/ward-server/stargazers">
      <img src="https://img.shields.io/github/stars/ward-framework/ward-server.svg?style=flat-square" alt="Stargazer">
    </a>
    <a href="https://github.com/ward-framework/ward-server/issues">
      <img src="https://img.shields.io/github/issues/ward-framework/ward-server.svg?style=flat-square" alt="Issues">
    </a>
    <a href="https://github.com/ward-framework/ward-server/blob/master/LICENSE.md">
      <img src="https://img.shields.io/github/license/ward-framework/ward-server.svg?style=flat-square" alt="License">
    </a>
    <a href="https://www.linkedin.com/in/colin-espinas/">
      <img src="https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555" alt="Linkedin">
    </a>
    <br />
    <br />
    <br />
  </p>
</p>



<!-- TABLE OF CONTENTS -->
## Table of Contents

* [About](#about)
* [Getting Started](#getting-started)
  * [Prerequisites](#prerequisites)
  * [Installation](#installation)
* [Usage](#usage)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
<!-- * [Acknowledgements](#acknowledgements) -->



<!-- ABOUT THE PROJECT -->
## About
A basic server using [connect](https://github.com/senchalabs/connect) and [server-static](https://github.com/expressjs/serve-static) to serve [Ward](https://github.com/ward-framework/ward) projects.


<!-- GETTING STARTED -->
## Getting Started

### Prerequisites

* [Node.js](https://nodejs.org)
* [npm](https://www.npmjs.com) or [Yarn](https://yarnpkg.com) (or any package manager)


### Installation

#### 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 EXAMPLES -->
## 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 -->
## 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 -->
## License

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



<!-- CONTACT -->
## Contact

Colin Espinas - [Website](https://colinespinas.com) - contact@colinespinas.com

Project link: [https://github.com/ColinEspinas/ward-server](https://github.com/ward-framework/ward-server)



<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements

* [connect](https://github.com/senchalabs/connect)
* [serve-static](https://github.com/expressjs/serve-static)
* [chalk](https://github.com/chalk/chalk)

---
_Source: https://npm.io/package/ward-server · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._