QuickNook

Table of contents

• General info
• Technologies
• Setup & Installation
• Running The App
• Viewing The App
• Viewing The API Documentation
• Features
• Status
• Contact

General info

A modern fullstack eCommerce application, built in FastAPI and React (Next.js) with Typescript, provides advanced eCommerce functionality with an intuitive user interface thanks to the Shadnc UI library. Unit tests in Pytest are embedded into the design to ensure code stability, and an advanced logging system for monitoring application performance and debugging.

Technologies

• Python 3.11.x
• FastAPI 0.104.1
• SQLite3
• Node.js v18.17.x
• TypeScript 5.4.x
• React 18.0.x
• Next.js 14.1.x
• TailwindCSS 3
• shadcn-ui 0.8.0
• HTML5
• CSS3

Setup & Installation

Backend configuration

Make sure you have the latest version of Python and pip and installed

Clone the repository using the following command

git clone https://github.com/Gamattowicz/QuickNook

Move to the app directory

cd QuickNook

Create a virtual environment

python -m venv venv

Active the virtual environment

.\venv\Scripts\activate

Install all the project Requirements

pip install -r requirements.txt

Frontend configuration

Install Node.js and Node Modules:

Move to directory frontend.

cd frontend

Next install all dependencies.

npm install

Running The App

In main directory run uvicorn web server:

uvicorn api.main:app --reload

Move to directory frontend.

cd frontend

Run the for development (the application is not currently designed for production):

npm run dev

Viewing The App

Go to http://localhost:3000/

Viewing The API Documentation

Go to http://127.0.0.1:8000/docs

Status

The application is under development.

Contact

Created by @Gamattowicz - feel free to contact me!