Xymorot/RenaiApp
Xymorot
/
RenaiApp
1
1
Fork 0
Code Issues Pull Requests Releases Activity
Hentai Library Thingy
85 Commits 1 Branch 0 Tags 2.3 MiB
TypeScript 98.2%
HTML 0.9%
JavaScript 0.9%
Go to file
Xymorot ad5d59cef9 config: remove lint processes from typescript and move prettier commit hooks via husky 2019-11-20 23:21:24 +01:00
resources feat: add icon/logo 2019-07-26 22:18:56 +02:00
src doc: make comment more generic to secure it against architectural changes 2019-11-20 23:21:24 +01:00
.editorconfig install tslint and prettier with stuff around to make them work together 2019-06-04 22:54:56 +02:00
.eslintignore feat: implement nhentai login and refactor large pieces of code in the process 2019-07-26 23:05:29 +02:00
.eslintrc.json config: remove lint processes from typescript and move prettier commit hooks via husky 2019-11-20 23:21:24 +01:00
.gitignore config: implement webpack dev mode by unifying gulp and webpack 2019-11-20 23:21:22 +01:00
.prettierrc.yml adjust prettier config 2019-06-30 02:00:26 +02:00
README.md doc: update commit types concerning comments 2019-11-20 23:21:23 +01:00
forge.config.js feat: install electron-forge and define build process 2019-07-26 22:28:22 +02:00
gulpfile.js config: implement webpack dev mode by unifying gulp and webpack 2019-11-20 23:21:22 +01:00
index.dev.html reformat: run prettier 2019-11-20 23:21:24 +01:00
index.prod.html config: implement webpack dev mode by unifying gulp and webpack 2019-11-20 23:21:22 +01:00
ormconfig.yml refactor entity folder structure 2019-06-23 17:30:51 +02:00
package-lock.json config: remove lint processes from typescript and move prettier commit hooks via husky 2019-11-20 23:21:24 +01:00
package.json config: remove lint processes from typescript and move prettier commit hooks via husky 2019-11-20 23:21:24 +01:00
tsconfig.json config: remove lint processes from typescript and move prettier commit hooks via husky 2019-11-20 23:21:24 +01:00
tslint.json config: remove lint processes from typescript and move prettier commit hooks via husky 2019-11-20 23:21:24 +01:00
webpack.config.js config: implement webpack dev mode by unifying gulp and webpack 2019-11-20 23:21:22 +01:00

README.md

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 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
  • 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 and handled by typeorm. Migrations are run on app start inside 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.