timoweave/resume

Introduction

Make an resume editor, so that user can create/retreive/update/delete user profile, work experience, school education, etc.,

1. localhost demo. run npm run dev and then vist http://localhost:5173/resume
2. docker demo. run docker run -it -p 5173:80 --rm timoweave/resume_nginx:latest, and then visit http://localhost:5173/resume
3. see demo

Stack

1. postgres dbms (good for relational db)
2. supabase (with the rpc api, generated typescript from postgres)
3. hook (to manage state)
4. react (with chakra, router)

Directory

1. .env has values to load supabase key/secret, which the developer must create. (see .env-example for example)

VITE_SUPABASE_URI='https://db.<MUST_GET_YOUR_SUPABSE_URI>.supabase.co'
VITE_SUPABASE_ANON_KEY='<MUST_GET_YOUR_SUPABASE_ANON_KEY>'

1. main.tsx is the JSX entry point to <Resume/> (thru routes.tsx).
2. api/ is for supbase rpc to communicate from frontend to backend, heavily templated for reusing with different tables.
3. components/ is for all RSX components.
4. hooks/ is for various hooks to manage resume editing possible.
5. sql/ is for SQL tables (view, function, procedure, trigger, enum if any)
6. doc/ for documentation...

Database

1. see sql/postgres.sql for the SQL tables.
2. see doc/resume-db-erd.png for the Entity Relational Diagram.

Layout

1. resume (root) this is the landing page for /resume route. here user will find three sections: profile, experience, and education)
2. Profile this section has profile itself plus address and phone. user can only update at the moment. But the database is design for multi-user use case.
3. Experience this section list the user work experiences, which can be added, updated, or deleted.
4. Education this sectoin list user school, which can be added, updated, or deleted.