handle it

Version

0.3.0

Main Tech Stack

Project root

• Lerna
• Husky

Browser package

• Apollo Client
• GraphQL
• React
• React-Intl
• Sass
• TypeScript

Server package

• Apollo Server Express
• Express
• GraphQL
• node.js
• PostgreSQL
• React-Intl
• TypeOrm
• TypeScript
• TypeGraphql

---

Documentation

Installation

1. Install node.js 14.16.0

2. Install npm 7.8

3. Install PostgreSQL 13

4. Run SQL Shell (psql) or launch pgAdmin to create Database (creating database tutorial)

CREATE DATABASE handle-it

5. Clone the repository

git clone https://github.com/aleksanderfret/handle-it.git

6. Go to the directory

cd handle-it

7. Install dependencies

npm run ci

8. Go to the server package directory

cd packages/server

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

touch .env

10. 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.

11. 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_KE, TOKEN_PUBLIC_KEY.

12. Start development (in the root directory)

npm start

13. Build for production

npm run build

---

Available scripts

 "audit": runs npm audit in root and for all packages
 "bootstrap": install all packages dependencies and links any cross dependencies
 "build": build project for production
 "check": runs lint, format and stylelint, test and compile scripts together,
 "ci" runs npm ci for all packages directories
 "ci:all": installs all project dependencies and runs bootstrap and hooks scripts
 "clean": removes node_modules from al packages
 "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,
 "lint": lint all the files using eslint,
 "lint:fix": lint and fix all files using eslint,
 "outdated": runs npm outdated for root and for 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,
 "start": runs project for development,
 "stylelint": lint all style files,
 "stylelint:fix": lint and fix all style files,
 "test": run tests or all packages