🛍️ 🔍 Kenja

Kenja is building AI search for e-commerce.

Set-Up

Frontend

To set up our frontend, enter the frontend directory and then install dependencies:

npm install

Backend

To set up our backend, create a virtual environment and install dependencies.

python3 -m venv env
source env/bin/activate
python3 -m pip install -r requirements.txt

To Run

Assuming all requirements are installed, first, run the backend API:

cd backend
uvicorn api:app --reload

Then, run the frontend:

cd frontend
npm run start

Coding Standards

Backend

We use Black as our Python code formatter and Flake8 as our linter. To use both, install all of the requirements. To check Black, try:

black .

To check Flake8, try:

flake8 .

We also set up setup.cfg to configure Flake8 to meet Black style.

Frontend

We use ESLint for linting and use the default VSCode formatter for formatting.

Deployment

Notes on deployment are here!