RenaiApp/README.md

![Renai](resources/logo.png 'Renai')

# レンアイ - Hentai Library Thingy

## Development

### Quickstart

- `npm install`, the postinstall runs
  - `npm run rebuild`
    - might need to install some build tools depending on your platform
- `npm run watch` for code transpilation (starts watchers)
- `npm run start`

### Git Commits

This project uses [Conventional Commits](https://www.conventionalcommits.or) with the following types:

- `feat`: features, if any part of your commit implements a new functionality or changes an existing one, use this
- `remove`: removal of existing code/functionality
- `fix`: bugfixes
- `refactor`: code refactoring
- `test`: any of the above, but with tests
- `update`: updating dependencies and associated code changes
- `config`: changing configuration (linters, build process)
- `doc`: documentation, including comments
- `reformat`: fixing code formatting

Always try to split up your changes into coherent commits, a single commit should do a single thing. If your commit needs to do more than one thing it should be labeled with the type coming first in this list.

### Database Migrations

Migrations are stored in [src/main/migrations](src/main/migrations) and handled by typeorm. Migrations are run on app start inside [database.ts](src/main/services/database.ts).

To auto-generate a migration:  
`node_modules/.bin/typeorm migration:generate -n <migration name> -c <connection name>`

To create an empty creation which can be filled with custom migration code:  
`node_modules/.bin/typeorm migration:create -n <migration name> -c <connection name>`

To run migrations:  
`node_modules/.bin/typeorm migration:run -c <connection name>`  
This is also pre-defined in the npm script `typeorm:migrate`.

### Testing

The testing framework of choice is [Mocha](https://mochajs.org/). Call `npm run test` to run all tests. Tests are written in typescript and need to be transpiled before testing.

- assertion is (mainly) done by [Chai](https://www.chaijs.com/)
- Electron specific testing is done by [Spectron](https://electronjs.org/spectron)
- spies, stubs and mocks are provided by [Sinon.JS](https://sinonjs.org/)
- HTTP server mocking is done by [nock](https://github.com/nock/nock)
- property based testing is made possible by [fast-check](https://github.com/dubzzz/fast-check)

#### Tagging

Mocha does [not have a seperate tagging feature](https://github.com/mochajs/mocha/wiki/Tagging), but it can filter via title. Us the following tags in your test titles:

- `@slow` when the test is particularly slow
feat: add icon/logo 2019-07-26 22:18:56 +02:00			`![Renai](resources/logo.png 'Renai')`

			`# レンアイ - Hentai Library Thingy`

install sqlite3 and typeorm together with electron-rebuild, create first entities 2019-06-23 02:30:24 +02:00			`## Development`
add README.md 2019-03-10 20:29:25 +01:00
doc: update README with conventional commits info 2019-07-02 21:44:13 +02:00			`### Quickstart`

update README.md to reflect older changes in postinstall script 2019-06-23 18:16:09 +02:00			- `npm install`, the postinstall runs
			- `npm run rebuild`
			`- might need to install some build tools depending on your platform`
config: implement webpack dev mode by unifying gulp and webpack Now gulp does everything and can be started with the 'build' task with optional --dev and --watch flags for those modes respectively. 2019-10-02 22:42:27 +02:00			- `npm run watch` for code transpilation (starts watchers)
			- `npm run start`
doc: update README with conventional commits info 2019-07-02 21:44:13 +02:00
			`### Git Commits`

			`This project uses [Conventional Commits](https://www.conventionalcommits.or) with the following types:`
doc: update commit documentation (add new type) 2019-07-26 22:19:28 +02:00
doc: add 'remove' commit type and refactor existing types 2019-11-20 23:19:22 +01:00			- `feat`: features, if any part of your commit implements a new functionality or changes an existing one, use this
			- `remove`: removal of existing code/functionality
doc: update README with conventional commits info 2019-07-02 21:44:13 +02:00			- `fix`: bugfixes
			- `refactor`: code refactoring
doc: clarify usage of the 'test' commit type 2019-10-10 23:48:56 +02:00			- `test`: any of the above, but with tests
doc: update commit documentation to better represent intent 2019-07-05 22:56:43 +02:00			- `update`: updating dependencies and associated code changes
			- `config`: changing configuration (linters, build process)
doc: update commit types concerning comments 2019-10-03 03:01:47 +02:00			- `doc`: documentation, including comments
doc: add 'remove' commit type and refactor existing types 2019-11-20 23:19:22 +01:00			- `reformat`: fixing code formatting
doc: update README with conventional commits info 2019-07-02 21:44:13 +02:00
doc: update commit documentation to better represent intent 2019-07-05 22:56:43 +02:00			`Always try to split up your changes into coherent commits, a single commit should do a single thing. If your commit needs to do more than one thing it should be labeled with the type coming first in this list.`
install sqlite3 and typeorm together with electron-rebuild, create first entities 2019-06-23 02:30:24 +02:00
add database migrations 2019-06-23 03:33:48 +02:00			`### Database Migrations`

feat: run typeorm database migrations on app start 2019-10-03 02:09:45 +02:00			`Migrations are stored in [src/main/migrations](src/main/migrations) and handled by typeorm. Migrations are run on app start inside [database.ts](src/main/services/database.ts).`
add database migrations 2019-06-23 03:33:48 +02:00
			`To auto-generate a migration:`
update initial migration and entities 2019-06-23 15:35:57 +02:00			`node_modules/.bin/typeorm migration:generate -n <migration name> -c <connection name>`
add database migrations 2019-06-23 03:33:48 +02:00
			`To create an empty creation which can be filled with custom migration code:`
update initial migration and entities 2019-06-23 15:35:57 +02:00			`node_modules/.bin/typeorm migration:create -n <migration name> -c <connection name>`
add database migrations 2019-06-23 03:33:48 +02:00
			`To run migrations:`
			`node_modules/.bin/typeorm migration:run -c <connection name>`
			This is also pre-defined in the npm script `typeorm:migrate`.
test: add test framework (spectron + mocha), combined with refactoring of the directory structures 2019-10-05 03:09:34 +02:00
test: remove split between integration and unit tests, use tags instead 2019-10-10 23:47:13 +02:00			`### Testing`
test: add test framework (spectron + mocha), combined with refactoring of the directory structures 2019-10-05 03:09:34 +02:00
test: remove split between integration and unit tests, use tags instead 2019-10-10 23:47:13 +02:00			The testing framework of choice is [Mocha](https://mochajs.org/). Call `npm run test` to run all tests. Tests are written in typescript and need to be transpiled before testing.

doc: add list of testing packages together with their usage 2019-10-12 02:21:27 +02:00			`- assertion is (mainly) done by [Chai](https://www.chaijs.com/)`
			`- Electron specific testing is done by [Spectron](https://electronjs.org/spectron)`
			`- spies, stubs and mocks are provided by [Sinon.JS](https://sinonjs.org/)`
			`- HTTP server mocking is done by [nock](https://github.com/nock/nock)`
config: install fast-check for property based testing 2019-10-12 02:22:30 +02:00			`- property based testing is made possible by [fast-check](https://github.com/dubzzz/fast-check)`
doc: add list of testing packages together with their usage 2019-10-12 02:21:27 +02:00
test: remove split between integration and unit tests, use tags instead 2019-10-10 23:47:13 +02:00			`#### Tagging`

			`Mocha does [not have a seperate tagging feature](https://github.com/mochajs/mocha/wiki/Tagging), but it can filter via title. Us the following tags in your test titles:`

			- `@slow` when the test is particularly slow