What's Seeking ?

Seeking is a Job Search Manager, which allows you to record, track, and view your job search journey. read more..

FastAPI / Next.js 14+ / Material UI / Redux / react-hook-form / zod / openapi / ..

A. How to use ?

Prerequisites: docker and git must be installed

Install

First install duration: +10min

Use git to clone the project on your local machine (will add a seeking subfolder):

git clone https://github.com/berdal84/seeking

Move to the new folder and build images:

cd seeking
docker compose build

Run

docker compose up -d

Add optionally the --build argument to build the docker images from sources instead of pulling them from docker hub: docker compose up -d --build

Once done, browse http://localhost:3000.

Stop

To stop the application, run the command docker compose stop.

B. How to develop?

Prerequisites

In dev mode, this project ONLY targets GNU/Linux platforms. But there is a good chance that it will also work as is for macOS. For Windows, however, you will need to make changes to the scripts and commands described in the documentation.

Short description of project's main folders:

• /webui/ contains the web user interface sources.
• /api/ contains the web api sources.
• /db/: utilities to backup the database

Before to continue, read webui, api, and db readme files.

Quick start (ONLY for tmux users)

Once both api and webui are installed, you can run the whole application quickly from a tmux session by running tmux-start.sh.

The script will basically split the current window to have a panel for the webui and an other for the api. Double check the script content before to run.

Run it:

./tmux-dev.sh

Credits

Seeking is developed by Bérenger D.