Skip to content

aleksanderfret/games-room

Repository files navigation

Games Room

games room

Documentation

Installation

1. Install node.js ^16

2. Install npm ^8

3. Clone the repository

git clone https://github.com/aleksanderfret/games-room.git

4. Go to the directory

cd games-room

5. Init project

npm run init

6. Create .env file in server package directory and add necessary .env keys that you can find in the .env.example file

touch .env

7. Create Sendgrid API Key

Create an account on sendgrid.com and get the Sendgrid API Key to make the app be able to send email messages. Save the key in your .env file as SENDGRID_API_KEY.

8. Generate RSA keys

Generate three paris of keys: private and public (you can do it here). Encode them (you can do it here). Save encoded keys in your .env file as: ACCESS_PRIVATE_KEY, ACCESS_PUBLIC_KEY, REFRESH_PRIVATE_KEY, REFRESH_PUBLIC_KEY, TOKEN_PRIVATE_KEY, TOKEN_PUBLIC_KEY.

9. Start development

npm start

Available scripts

 "audit": runs npm audit in root and for in packages
 "bootstrap": install all packages dependencies and links any cross dependencies
 "build": build project for production
 "check": runs lint, format and stylelint, test, compile and clean scripts together,
 "clean": removes node_modules from al packages,
 "clean:compiled": removes files created via `compile` script,
 "compile": runs TypeScript for all packages
 "create": creates a new lerna-managed package
 "format": formats all the files using Prettier,
 "format:fix": formats and fix all the files using Prettier,
 "init": installs dependencies and bootstrap project,
 "libs:root": generates third party libraries list for root directory,
 "libs": generates third party libraries for whole project,
 "lint": lint all the files using eslint,
 "lint:fix": lint and fix all files using eslint,
 "outdated": runs npm outdated for root and in all packages,
 "postinstall": runs bootstrap and hooks scripts,
 "prepare": install git hooks,
 "prepare-commit-msg": runs prepare-commit-msg hook,
 "pre-commit": runs pre-commit hook,
 "pre-push": runs pre-push hook,
 "reset": runs clean script and runs npm ci,
 "snapshot:update": updates test snapshots in all packages,
 "start": runs project for development,
 "storybook": runs storybook in all client packages,
 "stylelint": lint all style files,
 "test": run tests or all packages

Third party libraries

List of libraries we use

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages