ward-cli
v1.0.3
Published
A CLI tool for Ward
Downloads
4
Readme
Table of Contents
About
A CLI tool to create and serve Ward projects.
Getting Started
Prerequisites
Installation
# npm
npm install [-g] ward-cli
# Yarn
yarn [global] add ward-cli
Usage
new <name> [directory]
The new
command will create a project in the directory called <name>
(or create a new directory if it does not exist).
You can also specify a [directory]
to specify where to create this project.
#Exemple:
ward new MyWardProject Projects # Creates a project called "MyWardProject" in the "Projects" directory.
serve [directory]
- -P, --port : Wish port to listen to. (Default: 8000)
- -I, --ip : Wish IP address to serve to. (Default: "127.0.0.1")
The serve
command will serve the files of a specified [directory]
(if not specified will serve the current working directory).
#Exemple:
ward serve --port 3000 # Serves the current working directory to the port 3000.
Contributing
This project is developed by a somewhat beginner javascript developer, help is always welcome. Do not hesitate to contribute to the project.
- Fork the Project
- Create your Feature or Fix Branch (
git checkout -b feature/Feature
orgit checkout -b fix/Fix
) - Commit your Changes (
git commit -m 'Add some feature or fix'
) - Push to the Branch (
git push origin feature/Feature
orgit push origin fix/Fix
) - Open a Pull Request
License
ward-cli is distributed under the MIT License. See LICENSE
for more information.
Contact
Colin Espinas - Website - [email protected]
Project link: https://github.com/ColinEspinas/ward-cli