-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
root
committed
Jun 9, 2024
1 parent
88a40a4
commit 1c87694
Showing
3 changed files
with
33 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,44 @@ | ||
# Serve | ||
# hotweby | ||
|
||
![CI/CD](https://github.com/noblemajo/serve/actions/workflows/npm-publish.yml/badge.svg) | ||
![CI/CD](https://github.com/noblemajo/hotweby/actions/workflows/npm-publish.yml/badge.svg) | ||
![MIT](https://img.shields.io/badge/license-MIT-blue.svg) | ||
![typescript](https://img.shields.io/badge/dynamic/json?style=plastic&color=blue&label=Typescript&prefix=v&query=devDependencies.typescript&url=https%3A%2F%2Fraw.githubusercontent.com%2Fnoblemajo%2Fserve%2Fmain%2Fpackage.json) | ||
![npm](https://img.shields.io/npm/v/serve.svg?style=plastic&logo=npm&color=red) | ||
<!-- ![github](https://img.shields.io/badge/dynamic/json?style=plastic&color=darkviolet&label=GitHub&prefix=v&query=version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fnoblemajo%2Fserve%2Fmain%2Fpackage.json) --> | ||
![typescript](https://img.shields.io/badge/dynamic/json?style=plastic&color=blue&label=Typescript&prefix=v&query=devDependencies.typescript&url=https%3A%2F%2Fraw.githubusercontent.com%2Fnoblemajo%2Fhotweby%2Fmain%2Fpackage.json) | ||
![npm](https://img.shields.io/npm/v/hotweby.svg?style=plastic&logo=npm&color=red) | ||
<!-- ![github](https://img.shields.io/badge/dynamic/json?style=plastic&color=darkviolet&label=GitHub&prefix=v&query=version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fnoblemajo%2Fhotweby%2Fmain%2Fpackage.json) --> | ||
|
||
![](https://img.shields.io/badge/dynamic/json?color=green&label=watchers&query=watchers&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fserve) | ||
![](https://img.shields.io/badge/dynamic/json?color=yellow&label=stars&query=stargazers_count&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fserve) | ||
![](https://img.shields.io/badge/dynamic/json?color=navy&label=forks&query=forks&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fserve) | ||
<!-- ![](https://img.shields.io/badge/dynamic/json?color=darkred&label=open%20issues&query=open_issues&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fserve) | ||
![](https://img.shields.io/badge/dynamic/json?color=orange&label=subscribers&query=subscribers_count&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fserve) --> | ||
![](https://img.shields.io/badge/dynamic/json?color=green&label=watchers&query=watchers&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fhotweby) | ||
![](https://img.shields.io/badge/dynamic/json?color=yellow&label=stars&query=stargazers_count&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fhotweby) | ||
![](https://img.shields.io/badge/dynamic/json?color=navy&label=forks&query=forks&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fhotweby) | ||
<!-- ![](https://img.shields.io/badge/dynamic/json?color=darkred&label=open%20issues&query=open_issues&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fhotweby) | ||
![](https://img.shields.io/badge/dynamic/json?color=orange&label=subscribers&query=subscribers_count&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fhotweby) --> | ||
|
||
Automatic hot reloading webserver based on file watcher, websocket and id endpoint. | ||
Automatic hot reloading webhotwebyr based on file watcher, websocket and id endpoint. | ||
|
||
- [hotweby](#hotweby) | ||
- [Getting started](#getting-started) | ||
- [Contributing](#contributing) | ||
- [License](#license) | ||
- [Disclaimer](#disclaimer) | ||
|
||
---- | ||
|
||
# Getting started | ||
|
||
```sh | ||
npm i -g @noblemajo/serve | ||
npm i -g @noblemajo/hotweby | ||
``` | ||
|
||
```sh | ||
serve -p 8080 -d html | ||
hotweby -p 8080 -d html | ||
``` | ||
|
||
# Contributing | ||
Contributions to Serve are welcome! | ||
Contributions to hotweby are welcome! | ||
Interested users can refer to the guidelines provided in the [CONTRIBUTING.md](CONTRIBUTING.md) file to contribute to the project and help improve its functionality and features. | ||
|
||
# License | ||
Serve is licensed under the [MIT license](LICENSE), providing users with flexibility and freedom to use and modify the software according to their needs. | ||
hotweby is licensed under the [MIT license](LICENSE), providing users with flexibility and freedom to use and modify the software according to their needs. | ||
|
||
# Disclaimer | ||
Serve is provided without warranties. | ||
hotweby is provided without warranties. | ||
Users are advised to review the accompanying license for more information on the terms of use and limitations of liability. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
{ | ||
"name": "@noblemajo/serve", | ||
"version": "1.0.2", | ||
"name": "hotweby", | ||
"version": "1.0.3", | ||
"description": "Automatic hot reloading webserver based on file watcher, websocket and id endpoint", | ||
"type": "module", | ||
"main": "dist/index.js", | ||
"bin": { | ||
"serve": "./dist/index.js" | ||
"hotweby": "./dist/index.js" | ||
}, | ||
"scripts": { | ||
"start": "node --enable-source-maps dist/index.js -p 48080 -d test", | ||
|
@@ -38,13 +38,13 @@ | |
"email": "[email protected]", | ||
"url": "https://github.com/NobleMajo" | ||
}, | ||
"homepage": "https://github.com/NobleMajo/serve", | ||
"homepage": "https://github.com/NobleMajo/hotweby", | ||
"bugs": { | ||
"url": "https://github.com/NobleMajo/serve/issues" | ||
"url": "https://github.com/NobleMajo/hotweby/issues" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "[email protected]:NobleMajo/serve.git" | ||
"url": "[email protected]:NobleMajo/hotweby.git" | ||
}, | ||
"license": "MIT", | ||
"devDependencies": { | ||
|