toby/web-drs-backend
Archived
1
Fork 0
Code Issues Releases Activity

Update README.md remove ugly newlines

Browse source
This commit is contained in:
Tobias Berger 2022-02-07 11:14:15 +01:00
parent 3b41da3a53
commit cdcebdff7e
1 changed files with 3 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -4,13 +4,11 @@ Built in [TypeScript 4.5](https://www.typescriptlang.org/) with [rollup.js](http
## Install ## Install
Run the command `yarn install` Run the command `yarn install` (or the equivalent in your package manager of choice).
(or the equivalent in your package manager of choice).
## Build ## Build
Run the command `yarn build` Run the command `yarn build` (or the equivalent in your package manager of choice).
(or the equivalent in your package manager of choice).
This will run rollup with the project's `rollup.config.js`. This will run rollup with the project's `rollup.config.js`.
Alternatively, you can run rollup manually without a package manager. Alternatively, you can run rollup manually without a package manager.
@ -18,8 +16,7 @@ Alternatively, you can run rollup manually without a package manager.
## Run ## Run
Run the command `yarn start` Run the command `yarn start` (or the equivalent in your package manager of choice).
(or the equivalent in your package manager of choice).
The compiled script does not take any parameters. The compiled script does not take any parameters.
Any configuration needs to be done in-source, before the [building step](#build). Any configuration needs to be done in-source, before the [building step](#build).
@ -31,5 +28,4 @@ Alternatively, manually run `<your node path>/node ./server.node.bundle.js`
The combined script `yarn prod` (or equivalent) will run the build script and, if successful, the run 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 #### This package has only been tested on Linux with Node.js v17.3.0