# kamand-back

> Kamand back end

Latest version **4.0.55** (published 2021-01-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install kamand-back
pnpm add kamand-back
yarn add kamand-back
bun add kamand-back
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.55 |
| Published | 2021-01-09 |
| First published | 2019-05-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=8 |
| Dependencies | 14 |
| Unpacked size | 137.1 KB |
| Known vulnerabilities | 0 (+5 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Kayvan Arianpour |
| Maintainers | karianpour |

## Links

- npm: https://www.npmjs.com/package/kamand-back
- Repository: https://github.com/karianpour/kamand-back
- Homepage: https://github.com/karianpour/kamand-back#readme
- Issues: https://github.com/karianpour/kamand-back/issues
- npm.io page: https://npm.io/package/kamand-back

## Dependencies (14)

- [pg](https://npm.io/package/pg.md) ^8.5.1
- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [debug](https://npm.io/package/debug.md) ^4.3.1
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [fastify](https://npm.io/package/fastify.md) ^3.9.2
- [pg-format](https://npm.io/package/pg-format.md) ^1.0.4
- [socket.io](https://npm.io/package/socket.io.md) ^2.4.1
- [change-case](https://npm.io/package/change-case.md) ^4.1.2
- [fastify-jwt](https://npm.io/package/fastify-jwt.md) ^2.2.0
- [fastify-cors](https://npm.io/package/fastify-cors.md) ^5.1.0
- [fastify-plugin](https://npm.io/package/fastify-plugin.md) ^3.0.0
- [fastify-swagger](https://npm.io/package/fastify-swagger.md) ^3.5.0
- [fastify-file-upload](https://npm.io/package/fastify-file-upload.md) ^3.0.0
- [sql-bricks-postgres](https://npm.io/package/sql-bricks-postgres.md) ^0.5.0

## Recent versions

- 4.0.55 (latest) — 2021-01-09
- 4.0.54 — 2020-11-04
- 4.0.53 — 2020-11-01
- 4.0.52 — 2020-08-24
- 4.0.51 — 2020-08-22
- 4.0.50 — 2020-08-03
- 3.0.49 — 2020-07-27
- 3.0.48 — 2020-07-26
- 2.0.46 — 2020-07-19
- 2.0.45 — 2020-07-19
- 2.0.44 — 2020-07-18
- 2.0.43 — 2020-06-09
- 2.0.42 — 2020-05-19
- 2.0.41 — 2020-05-11
- 2.0.40 — 2020-04-26
- … 21 more at https://npm.io/package/kamand-back/versions

## README

# Dev & Debug

In order to start the example

```bash
npm start
```

If you want to re-run as you save a file

```bash
npm run start:watch
```

# Publish

```bash
npm run build
npm publish
```

# Tests
All tests are located inside the `src/test` folder.

## To run all tests: 
```
npm test
```

The file `src/example/setup.js` runs before the tests,
it starts the server and initializes the db
and `src/example/teardown.js` is run after for teardown.

if `src/example/teardown.js` somehow does not run, you'll have to kill the dev server `node` process manually.

### To work on a single test file:

First run the development server:
```shell script
npm run start:watch
```
then seperately run the test file:
```shell script
node  --require=ts-node/register src/test/example/kamand.test.ts
```


### Configuring tests when using kamand as a dependency
1. Create files `src/setup.js`, `src/teardown.js` using the example
2. Add `test` in the scripts section in the `package.json` file.
3. Add tests in the `test` folder using the example test.

# DB Migrations
we can use postgres-migrations for database migration

---
_Source: https://npm.io/package/kamand-back · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._