README.md

vault-front-homework

Objectives

The main goal of the homework is to build a simple interface to search accross a list of notifications.

You will be provided with a backend with a search endpoint that handles the server part. ⚠️ There is a bug in the search code that you will have to fix 😏

The current frontend is very minimal (and/or ugly) and you will be welcomed to:

• develop a nice UI/UX experience. Mockups in this document just give a rough indications of what are the features of the application. Feel free to implement any layout you find pretty and that offers the best UX experience
• create any components you would need and feel free to restructure the files architecture
• ⚠️ we intentionnally put some bugs/problems in the code, happy debugging 🥳
• add code quality tools (linting, formatting)
• 🎁 bonus a github action to run those tools
• 🎁 bonus anything cool you have in mind

Getting started

• fork and clone this repository
• complete the homework
• add as many commits as you want
• push your work on your fork
• the deliverable will be your fork URL 🚀

We hope you will enjoy the challenge 💪

Launch the backend

# build the server image
$ docker build -t vault-front-homework:latest server

# run the server image
$ docker run -p 5000:5000 vault-front-homework:latest

Launch the frontend

# install dependencies
pnpm install

# run the dev server
pnpm dev

Frontend custom scripts

# run the unit tests
pnpm test            # jest --coverage

# run the linter
pnpm lint            # eslint .

# format the code
pnpm format          # prettier --write --ignore-unknown

# run precommit command
pnpm precommit