nexuspy / webquick

simple CLI to get started with web dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

WebQuick

Generate HTML, CSS, and JavaScript boilerplate with a live server.

Installation

To use WebQuick as a global command-line tool, you can install it using npm. Open your terminal and run the following command:

npm install -g webquick

Once the installation is complete, you can use WebQuick from the command line by running webquick.

Usage

Generating Boilerplate

To generate boilerplate files for a new project, use the generate (or g) command followed by the project name. For example:

webquick generate myproject
webquick g myProject

This will create a new directory named myproject with the basic HTML, CSS, and JavaScript files.

Starting a Live Server

To start a live server for a project, use the serve (or s) command followed by the project name. For example:

webquick serve myproject
webquick s myProject

This will start a live server for the project, and you can access it at http://localhost:3000.

Contributing

This is my first ever npm package, If you'd like to contribute to this project, you are welcome to submit pull requests. Please follow these guidelines:

  1. Fork the repository and create a new branch for your feature or bug fix.
  2. Make your changes and ensure the code is well-documented.
  3. Run tests if available to make sure your changes do not break existing functionality.
  4. Submit a pull request with a clear title and description explaining the purpose of your changes.

License

This project is licensed under the ISC License.


Feel free to open issues if you encounter any problems or have suggestions for improvements. Happy coding!

About

simple CLI to get started with web dev

License:ISC License


Languages

Language:JavaScript 100.0%