31 lines
570 B
Markdown
31 lines
570 B
Markdown
|
# Debreviator
|
||
|
|
Creates meaning by undoing your abbreviation.
|
||
|
|
|
||
|
|
## Development
|
||
|
|
### Requirements
|
||
|
|
* [npm](https://www.npmjs.com/)
|
||
|
|
|
||
|
|
### Setting up
|
||
|
|
```shell script
|
||
|
|
# Install dependencies (only needed once)
|
||
|
|
$> npm ci
|
||
|
|
```
|
||
|
|
|
||
|
|
### Building
|
||
|
|
```shell script
|
||
|
|
# Build the tool in `dist/` for development
|
||
|
|
$> npm run dev
|
||
|
|
# Same as above, but automatically rerun it whenever files are changed
|
||
|
|
$> npm run dev:server
|
||
|
|
# Build the tool in `dist/` for deployment
|
||
|
|
$> npm run deploy
|
||
|
|
```
|
||
|
|
|
||
|
|
### Publishing
|
||
|
|
```shell script
|
||
|
|
# Log in to npm
|
||
|
|
$> npm login
|
||
|
|
# Push to npm
|
||
|
|
$> npm publish --access public
|
||
|
|
```
|