Skip to content

Commit

Permalink
chore(): docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
chyzwar committed Mar 26, 2023
1 parent 0dad6e8 commit 290cccc
Show file tree
Hide file tree
Showing 9 changed files with 208 additions and 274 deletions.
4 changes: 2 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This project require number of tools available.

Repo provides an init script that will bootstrap baseline env files
It will check if the user has docker and docker-compose installed.
For OAuth to work, google and facebook configs need to update in packages/api .env
For OAuth to work, google and facebook configs need to updated in packages/api .env

Clone repository

Expand All @@ -39,7 +39,7 @@ Start project
yarn start
```

You can now visit: http://localhost:80
You can now visit: http://localhost:3000

Setup local domains resolution(optional)
This is useful for CSP and reflect prod deployment better than running on localhost
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"scripts": {
"initialize": ".local/init.sh",
"prestart": "yarn install",
"start": "runner start",
"start": "docker-compose up",
"lint": "eslint . --ext .ts,.js,.tsx",
"lint:fix": "eslint . --ext .ts,.js,.tsx --fix",
"build": "tsc --build",
Expand All @@ -26,11 +26,11 @@
"postinstall": "husky install"
},
"dependencies": {
"@commitlint/cli": "^17.4.4",
"@commitlint/cli": "^17.5.0",
"@commitlint/config-conventional": "^17.4.4",
"@project/eslint-config": "^0.2.0",
"@typescript-eslint/eslint-plugin": "^5.55.0",
"@typescript-eslint/parser": "^5.55.0",
"@typescript-eslint/eslint-plugin": "^5.56.0",
"@typescript-eslint/parser": "^5.56.0",
"eslint": "^8.36.0",
"husky": "^8.0.3",
"jest": "^29.5.0",
Expand Down
8 changes: 4 additions & 4 deletions packages/admin-ui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@
},
"devDependencies": {
"@project/eslint-config": "^0.2.0",
"@testing-library/dom": "^9.0.1",
"@testing-library/dom": "^9.2.0",
"@testing-library/jest-dom": "^5.16.5",
"@testing-library/react": "^14.0.0",
"@testing-library/user-event": "^14.4.3",
"@types/jest": "^29.5.0",
"@types/node": "^18.15.3",
"@types/react": "^18.0.28",
"@types/node": "^18.15.10",
"@types/react": "^18.0.29",
"@types/react-dom": "^18.0.11",
"@vitejs/plugin-react-swc": "^3.2.0",
"eslint": "^8.36.0",
"jest": "^29.5.0",
"jest-environment-jsdom": "^29.5.0",
"typescript": "^5.0.2",
"vite": "^4.2.0"
"vite": "^4.2.1"
},
"scripts": {
"start": "vite",
Expand Down
14 changes: 7 additions & 7 deletions packages/api/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,32 +21,32 @@
"dependencies": {
"@fastify/cookie": "^8.3.0",
"@fastify/helmet": "^10.1.0",
"@fastify/http-proxy": "^8.4.0",
"@fastify/http-proxy": "^9.0.0",
"@fastify/jwt": "^6.7.1",
"@fastify/oauth2": "^7.0.0",
"@fastify/oauth2": "^7.0.1",
"@fastify/static": "^6.9.0",
"@project/common": "workspace:packages/common",
"axios": "^1.3.4",
"fastify": "^4.14.1",
"fastify": "^4.15.0",
"fastify-plugin": "^4.5.0",
"pg": "^8.10.0",
"pino": "^8.11.0",
"pino-pretty": "^10.0.0",
"sequelize": "^6.29.3"
"sequelize": "^6.30.0"
},
"devDependencies": {
"@jest/globals": "^29.5.0",
"@project/eslint-config": "^0.2.0",
"@swc/cli": "^0.1.62",
"@swc/core": "^1.3.41",
"@swc/core": "^1.3.42",
"@swc/jest": "^0.2.24",
"@types/jest": "^29.5.0",
"@types/node": "^18.15.3",
"@types/node": "^18.15.10",
"@types/validator": "^13.7.14",
"dotenv": "^16.0.3",
"env-cmd": "^10.1.0",
"eslint": "^8.36.0",
"nodemon": "^2.0.21",
"nodemon": "^2.0.22",
"sequelize-cli": "^6.6.0",
"ts-node": "^10.9.1",
"typescript": "^5.0.2"
Expand Down
3 changes: 1 addition & 2 deletions packages/api/src/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,10 @@ process.on("uncaughtException", (error) => {
const server = await createServer();

try {
const address = await server.listen({
await server.listen({
host: "0.0.0.0",
port: Number(process.env.API_PORT),
});
logger.info(`Server listening in ${address}`);
}
catch (error) {
logger.error(error, "Server fail to listen");
Expand Down
4 changes: 2 additions & 2 deletions packages/common/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
"license": "UNLICENSED",
"devDependencies": {
"@project/eslint-config": "^0.2.0",
"@typescript-eslint/eslint-plugin": "^5.55.0",
"@typescript-eslint/parser": "^5.55.0",
"@typescript-eslint/eslint-plugin": "^5.56.0",
"@typescript-eslint/parser": "^5.56.0",
"eslint": "^8.36.0",
"jest": "^29.5.0",
"typescript": "^5.0.2"
Expand Down
4 changes: 2 additions & 2 deletions packages/eslint-config/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
"eslint"
],
"dependencies": {
"@typescript-eslint/eslint-plugin": "^5.55.0",
"@typescript-eslint/parser": "^5.55.0",
"@typescript-eslint/eslint-plugin": "^5.56.0",
"@typescript-eslint/parser": "^5.56.0",
"eslint-plugin-jest": "^27.2.1",
"eslint-plugin-react-hooks": "^4.6.0",
"find-up": "^6.3.0"
Expand Down
10 changes: 5 additions & 5 deletions packages/ui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,23 @@
},
"devDependencies": {
"@project/eslint-config": "^0.2.0",
"@swc/core": "^1.3.41",
"@swc/core": "^1.3.42",
"@swc/jest": "^0.2.24",
"@testing-library/dom": "^9.0.1",
"@testing-library/dom": "^9.2.0",
"@testing-library/jest-dom": "^5.16.5",
"@testing-library/react": "^14.0.0",
"@testing-library/user-event": "^14.4.3",
"@types/jest": "^29.5.0",
"@types/node": "^18.15.3",
"@types/react": "^18.0.28",
"@types/node": "^18.15.10",
"@types/react": "^18.0.29",
"@types/react-dom": "^18.0.11",
"@vitejs/plugin-react-swc": "^3.2.0",
"dotenv": "16.0.3",
"eslint": "^8.36.0",
"jest": "^29.5.0",
"jest-environment-jsdom": "^29.5.0",
"typescript": "^5.0.2",
"vite": "^4.2.0"
"vite": "^4.2.1"
},
"scripts": {
"start": "vite",
Expand Down
Loading

0 comments on commit 290cccc

Please sign in to comment.