1
Fork 0

Clean up package files

Add LICENSE, README.md, and improve package.json
This commit is contained in:
Tobias Berger 2022-02-07 10:11:59 +01:00
parent 6a22270d4e
commit e100eb80e6
Signed by: toby
GPG key ID: 2D05EFAB764D6A88
3 changed files with 72 additions and 14 deletions

24
LICENSE Normal file
View file

@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <https://unlicense.org/>

31
README.md Normal file
View file

@ -0,0 +1,31 @@
# Backend for Minimal Non-Persistent chat
Built in TypeScript 4.5 with rollup
## Install
Run the command `yarn install`
(or the equivalent in your package manager of choice).
## Build
Run the command `yarn build`
(or the equivalent in your package manager of choice).
This will run rollup with the project's `rollup.config.js`.
Alternatively, you can run rollup manually without a package manager.
(cf. [rollup's guide](https://rollupjs.org/guide/) for a how-to)
## Run
Run the command `yarn start`
(or the equivalent in your package manager of choice).
The compiled script does not take any parameters.
Any configuration needs to be done in-source, before the [building step](#build).
This will run the compiled JavaScript file with the environment's `node` executable.
Alternatively, manually run `<your node path>/node ./server.node.bundle.js`
#### This package has only been tested on Linux.

View file

@ -1,26 +1,28 @@
{ {
"name": "web-drs-backend", "name": "web-drs-backend",
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "Backend for a non-persistent minimal chat application",
"homepage": "https://home.tobot.dev/toby/web-drs-backend",
"bugs": {
"url": "https://home.tobot.dev/toby/web-drs-backend/issues",
"email": "tobi.berger13@gmail.com"
},
"license": "Unlicense",
"author": {
"name": "Tobias Berger"
"email": "tobi.berger13@gmail.com",
"url": "https://tobot.dev/"
},
"main": "server.node.bundle.js", "main": "server.node.bundle.js",
"directories": { "repository": {
"lib": "lib" "type": "git",
"url": "git+https://github.com/Toby222/web-drs-backend.git"
}, },
"scripts": { "scripts": {
"prod": "yarn build && yarn start", "prod": "yarn build && yarn start",
"start": "node server.node.bundle.js", "start": "node server.node.bundle.js",
"build": "rollup --config ./rollup.config.js" "build": "rollup --config ./rollup.config.js"
}, },
"repository": {
"type": "git",
"url": "git+https://github.com/Toby222/web-drs-backend.git"
},
"author": "Tobias Berger <tobi.berger13@gmail.com>",
"license": "Unlicense",
"bugs": {
"url": "https://github.com/Toby222/web-drs-backend/issues"
},
"homepage": "https://github.com/Toby222/web-drs-backend#readme",
"devDependencies": { "devDependencies": {
"@rollup/plugin-commonjs": "^21.0.1", "@rollup/plugin-commonjs": "^21.0.1",
"@rollup/plugin-node-resolve": "^13.1.3", "@rollup/plugin-node-resolve": "^13.1.3",
@ -30,5 +32,6 @@
"rollup-plugin-typescript2": "^0.31.1", "rollup-plugin-typescript2": "^0.31.1",
"typescript": "^4.5.4", "typescript": "^4.5.4",
"ws": "^8.4.2" "ws": "^8.4.2"
} },
"private": true
} }