1
Fork 0
This repository has been archived on 2022-02-28. You can view files and clone it, but cannot push or open issues or pull requests.
web-drs-backend/README.md

31 lines
1.1 KiB
Markdown

# Backend for Minimal Non-Persistent chat
Built in [TypeScript 4.5](https://www.typescriptlang.org/) with [rollup.js](https://rollupjs.org/)
## 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`
### Combined script
The combined script `yarn prod` (or equivalent) will run the build script and, if successful, the run script.
## This package has only been tested on Linux with Node.js v17.3.0