diff --git a/README.md b/README.md index 1cf199a..a71c3da 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,46 @@ [![Client CI](https://github.com/berdal84/seeking/actions/workflows/client.yml/badge.svg)](https://github.com/berdal84/seeking/actions/workflows/client.yml) -## What's Seeking? +## Intro + +### What's Seeking? _Seeking_ is a job search manager. This tool provides features to organize, track, and visualize job applications. -## Captures +### How does it looks like? -_WIP_ +Let's describe _Seeking_ UI/UX from the capture below. -## Why does Seeking exist? +In terms of UI, it is divided in three main panels (_List_, _Selection_, and _Visualization_) topped by a _Navigation Bar_. -The main goal was the implementation of a web client-server application to practice _Python_ and _TypeScript_ using respectively _FastAPI_ and _Next.js_. -There is no intend to push the work beyond the development stage. +On the top left area, the _List Panel_ shows the first _n_ job applications is a paginated table. Seleting any item from the list shows its details in the _Selection Panel_ on the top right area where events can be added/removed/edited. + +On the bottom area, the _Visualization Panel_ represents the evolution of the job applications as a _Sankey diagram_. + +![img](img/2024-04-04-capture-01.png) + +In terms of UX, when user selects an item (either from the list or the diagram), the selected items gets highlighted in the diagram and the list. + +The _Search Input_ is not functionnal yet, but the goal is to filter job applications by typing a job name, company, date, or a given event type. ## Details +### Why does Seeking exist? + +The main goal was the implementation of a web client-server application to practice _Python_ and _TypeScript_ using the following technologies: +- _FastAPI_ +- _Next.js_ +- _Material UI_ +- _Redux Toolkit_ +- _axios_ +- _openapi-typescript_ + +There is no intend to push the work beyond the development stage. + +### Folder structure + This project is split into two main folders: - frontend code: [./client](./client/README.md) - backend code: [./server](./server/README.md) diff --git a/img/2024-04-04-capture-01.png b/img/2024-04-04-capture-01.png new file mode 100644 index 0000000..1681d0c Binary files /dev/null and b/img/2024-04-04-capture-01.png differ