Hentai Library Thingy
Go to file
Xymorot f926cbb398 config: add typescript compile to postinstall script 2019-07-02 23:21:46 +02:00
src fix: change root styles to global 2019-07-02 22:23:07 +02:00
.editorconfig install tslint and prettier with stuff around to make them work together 2019-06-04 22:54:56 +02:00
.eslintignore uninstall electron-forge, switch to manual webpack for frontend/tsc for backend, install eslint 2019-06-16 00:41:43 +02:00
.eslintrc.json change eslint rules to warnings, add more rules 2019-06-26 23:29:53 +02:00
.gitignore install sqlite3 and typeorm together with electron-rebuild, create first entities 2019-06-23 02:30:24 +02:00
.prettierrc.yml adjust prettier config 2019-06-30 02:00:26 +02:00
README.md doc: add update to commit types 2019-07-02 22:17:00 +02:00
gulpfile.js add source maps back to typescript transpilation via gulp-sourcemaps 2019-06-24 00:01:50 +02:00
index.html adjust prettier config 2019-06-30 02:00:26 +02:00
ormconfig.yml refactor entity folder structure 2019-06-23 17:30:51 +02:00
package-lock.json run npm update and set version of non-critical packages to latest 2019-07-02 21:36:03 +02:00
package.json config: add typescript compile to postinstall script 2019-07-02 23:21:46 +02:00
tsconfig.json add source maps back to typescript transpilation via gulp-sourcemaps 2019-06-24 00:01:50 +02:00
tslint.json implement nhentai login 2019-06-30 01:18:21 +02:00
webpack.config.js implement nhentai login 2019-06-30 01:18:21 +02:00

README.md

Development

Quickstart

  • npm install, the postinstall runs
    • npm run rebuild
      • might need to install some build tools depending on your platform
    • npm run typeorm:migrate for installing the database
  • npm run tsc for backend
  • npm run webpack for frontend
  • npm run dev

Git Commits

This project uses Conventional Commits with the following types:

  • feat: features, if any part of your commit implements a new function, use this
  • fix: bugfixes
  • doc: documentation
  • refactor: code refactoring
  • config: changing configuration (linter, build process)
  • update: updating dependencies and associated changes

Always try to split up your changes into coherent commits, a single commit should do a single thing.

Database Migrations

Migrations are stored in src/main/migrations and handled by typeorm.

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.