RenaiApp/README.md

44 lines
1.5 KiB
Markdown
Raw Normal View History

2019-07-26 22:18:56 +02:00
![Renai](resources/logo.png 'Renai')
# レンアイ - Hentai Library Thingy
## Development
2019-03-10 20:29:25 +01:00
### 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
2019-06-16 21:41:04 +02:00
- `npm run tsc` for backend
- `npm run webpack` for frontend
- `npm run dev`
### 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, 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.
2019-06-23 03:33:48 +02:00
### Database Migrations
Migrations are stored in [src/main/migrations](src/main/migrations) and handled by typeorm.
To auto-generate a migration:
2019-06-23 15:35:57 +02:00
`node_modules/.bin/typeorm migration:generate -n <migration name> -c <connection name>`
2019-06-23 03:33:48 +02:00
To create an empty creation which can be filled with custom migration code:
2019-06-23 15:35:57 +02:00
`node_modules/.bin/typeorm migration:create -n <migration name> -c <connection name>`
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`.