Microservice, including story elements, rendered on the frontend - EOL since this app

TypeScript 85.7%
JavaScript 13.5%
Makefile 0.3%
Dockerfile 0.3%
Shell 0.2%

Find a file

Jakub 800745d36a Merge pull request #5 from Monsters-RPG-game/feat/eslintFlatConfig Feat: Rewritten config to flat config		2024-08-15 16:13:05 +00:00
__tests__	fixed some test, added get narrator story by params	2024-07-19 21:04:13 +02:00
config	init	2024-07-13 14:47:31 +02:00
src	Feat: Rewritten config to flat config	2024-08-15 18:09:59 +02:00
.editorconfig	init	2024-07-13 14:47:31 +02:00
.gitignore	init	2024-07-13 14:47:31 +02:00
.prettierrc	init	2024-07-13 14:47:31 +02:00
Dockerfile	init	2024-07-13 14:47:31 +02:00
eslint.config.mjs	Feat: Rewritten config to flat config	2024-08-15 18:09:59 +02:00
licence.md	init	2024-07-13 14:47:31 +02:00
makefile	init	2024-07-13 14:47:31 +02:00
package.json	Feat: Rewritten config to flat config	2024-08-15 18:09:59 +02:00
README.md	init	2024-07-13 14:47:31 +02:00
start.sh	init	2024-07-13 14:47:31 +02:00
tsconfig.json	init	2024-07-13 14:47:31 +02:00
tsconfig.release.json	init	2024-07-13 14:47:31 +02:00

README.md

Monsters - story

1. How to start

Install dependencies

npm install / yarn

Prepare environment

2. How to build

npm run build / yarn build

If you even encounter strange build behavior, tsconfig is set to create build with cache. Set option incremental in tsConfig to false

3. Useful information

3.1 Logs folder

Linux

~/.cache/"package.json -> productName"/logs

Windows

~/AppData/Roaming/"package.json -> productName"/logs

3.2 Testing

All test currently are written using jest. You can run all tests or just type specific tests

Available targets

yarn tests = run all tests
yarn tests:e2e = run 'end to end' tests
yarn tests:db = run 'database' tests
yarn tests:unit = run 'unit' tests
yarn test:watch = run tests in 'watch' mode

Alongside tests, this app have 'test mode' which will help you run e2e tests. It runs in memory instance of mongoDB and fill it with "fakeData.json" data