From aa5941752f18b68ac48784703860886ce7ecb57e Mon Sep 17 00:00:00 2001 From: fcablik Date: Fri, 2 Feb 2024 13:13:34 +0100 Subject: [PATCH] readme update --- README.md | 54 ++++++++++++++++++++---------------------------------- 1 file changed, 20 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 808f5bb..7d19ddf 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,7 @@ ### Tests - user tests currently set-up for 'admin' permissions only as the base app doesn't allow user sign-up (onboarding) and user/users profile sections are existing user's permission access only - -


-### Deployed App +
# Deployment @@ -172,16 +170,20 @@ just make sure to remove the move step from the `.github/workflows/deploy.yml`.
- -#### fonts +### Used Fonts - main-use/using: Nunito Sans, Nunito Sans Fallback (Google Font) - - consider: SF Pro (Apple Font), Adobe Clean (Adobe Font) - - nunito - more circular like, but sf pro is more readable in small sizes +### Used Components + ##### radix ui + - "@radix-ui/react-checkbox": "^1.0.4", + - "@radix-ui/react-dropdown-menu": "^2.0.5", + - "@radix-ui/react-label": "^2.0.2", + - "@radix-ui/react-slot": "^1.0.2", + - "@radix-ui/react-toast": "^1.1.4", + - "@radix-ui/react-tooltip": "^1.0.6", -#### components - - radix ui - - sonner (https://sonner.emilkowal.ski/) (toast) + ##### sonner (https://sonner.emilkowal.ski/) + - toast
@@ -194,7 +196,7 @@ just make sure to remove the move step from the `.github/workflows/deploy.yml`.
-### The Epic Stack + -### Useful Project's Commands +## Useful Project's Commands #### mac rubbish files in project removal ! - "find ./ -name ".DS_Store" -print -delete" @@ -245,7 +247,7 @@ just make sure to remove the move step from the `.github/workflows/deploy.yml`.
-#### App's Admin Docs +## Services Docs #### fly.io 1. register to fly.io @@ -262,27 +264,11 @@ just make sure to remove the move step from the `.github/workflows/deploy.yml`.
-## radix/ui components - - "@radix-ui/react-checkbox": "^1.0.4", - - "@radix-ui/react-dropdown-menu": "^2.0.5", - - "@radix-ui/react-label": "^2.0.2", - - "@radix-ui/react-slot": "^1.0.2", - - "@radix-ui/react-toast": "^1.1.4", - - "@radix-ui/react-tooltip": "^1.0.6", - -## git syntaxes - - "git log -2" - - - ## seeding production DB (from Kent) ---------------------------------- Manual Seeding -------------------------- --- Hey there, Kent here! This is how you can reliably seed your database with --- some data. You edit the migration.sql file and that will handle it for you. --- I determined this by running a minimal seed via --- `MINIMAL_SEED=true npx prisma db seed` and then creating a sql dump via --- `sqlite3 prisma/data.db .dump > seed.sql`. Then I grabbed the relevant bits --- for the initial seed and put them here. +------------------------- Manual Seeding Acc. To Kent in Epic-Stack ------------------------- +Hey there, Kent here! This is how you can reliably seed your database with some data. You edit the migration.sql file and that will handle it for you. I determined this by running a minimal seed via `MINIMAL_SEED=true npx prisma db seed` and then creating a sql dump via `sqlite3 prisma/data.db .dump > seed.sql`. Then I grabbed the relevant bits for the initial seed and put them here. + +
## custom notes for better development 1. expressions