Xymorot/RenaiApp
Xymorot
/
RenaiApp
1
1
Fork 0
Code Issues Pull Requests Releases Activity
Hentai Library Thingy
64 Commits 1 Branch 0 Tags 2.3 MiB
TypeScript 98.2%
HTML 0.9%
JavaScript 0.9%
Go to file
Xymorot 61b4bf2cdb feat: install electron-forge and define build process 2019-07-26 22:28:22 +02:00
resources feat: add icon/logo 2019-07-26 22:18:56 +02:00
src refactor: prepare code for more than one database 2019-07-05 22:51:05 +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 feat: install electron-forge and define build process 2019-07-26 22:28:22 +02:00
.gitignore feat: install electron-forge and define build process 2019-07-26 22:28:22 +02:00
.prettierrc.yml adjust prettier config 2019-06-30 02:00:26 +02:00
README.md doc: update commit documentation (add new type) 2019-07-26 22:19:28 +02:00
forge.config.js feat: install electron-forge and define build process 2019-07-26 22:28:22 +02:00
gulpfile.js add source maps back to typescript transpilation via gulp-sourcemaps 2019-06-24 00:01:50 +02:00
index.html refactor: remove unnecessary CSP header source 2019-07-26 22:20:57 +02:00
ormconfig.yml refactor entity folder structure 2019-06-23 17:30:51 +02:00
package-lock.json feat: install electron-forge and define build process 2019-07-26 22:28:22 +02:00
package.json feat: install electron-forge and define build process 2019-07-26 22:28:22 +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

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 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 functionality, use this
  • fix: bugfixes
  • refactor: code refactoring
  • update: updating dependencies and associated code changes
  • doc: documentation
  • config: changing configuration (linters, build process)
  • 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.

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.