https://github.com/willemverbuyst/bookworm

full-stack hobby/study project
https://github.com/willemverbuyst/bookworm

bash chakraui fastapi overmind python sql vite vitest

Last synced: 7 months ago
JSON representation

full-stack hobby/study project

• Host: GitHub
• URL: https://github.com/willemverbuyst/bookworm
• Owner: willemverbuyst
• Created: 2021-12-18T13:35:34.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-05T04:59:36.000Z (about 1 year ago)
• Last Synced: 2024-10-06T06:04:21.859Z (about 1 year ago)
• Topics: bash, chakraui, fastapi, overmind, python, sql, vite, vitest
• Language: TypeScript
• Homepage:
• Size: 6.13 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![Frontend - format, lint & type check](https://github.com/willemverbuyst/bookworm/actions/workflows/format-lint.yml/badge.svg)](https://github.com/willemverbuyst/bookworm/actions/workflows/format-lint.yml)

# What is this?

A project to connect and try out some libraries, tools and techniques in a semi-docker environment (all wip).

## Frontend

- TypeScript

- React

- Overmind

- Chakra ui

- React Hook Form

- Recharts

## Backend

- Python

- Fastapi

## Database

- Postgres

- SQL

- Bash

## Test

- Cypress

- Vitest

## Screenshots

![](./screenshots/Screenshot_bookworm_libraries.png)

![](./screenshots/Screenshot_books_overview.png)

![](./screenshots/Screenshot_books_languages.png)

![](./screenshots/Screenshot_books_genres.png)

![](./screenshots/Screenshot_books_year_published.png)

![](./screenshots/Screenshot_authors_pagesvsbooks.png)

![](./screenshots/Screenshot_rentals_duration.png)

## Documentation for API

![](./screenshots/Screenshot_api_docs.png)

Swagger docs at localhost:8000/docs

# Commands

Run backend for dev

> docker-compose --profile backend-only -f docker-compose.yml -f docker-compose.dev.yml up

#

Seed database for dev

> docker exec -it bw_backend bash

> cd database/dummy_data

> bash set_up_db.sh

> exit

#

run frontend for dev

> cd frontend

> yarn dev

#

see logs for service

> docker-compose logs 

#

start specific service

> docker-compose up 

#

log into container

> docker exec -it  bash

#

stop containers

> docker-compose down

stop development container and remove volume

> docker-compose -f docker-compose.yml -f docker-compose.dev.yml down -v

#

seed database

> docker-compose run backend bash

> cd database/dummy_data

> bash set_up_db.sh

#

format python

> docker-compose run backend bash

> black .

#

stop bash in terminal

> exit

> docker-compose stop

#

run cypress test (needs work)

> cd test

> npm run cy:open

> npm run cy:run

## Frontend dependency graph

![](./frontend/graph.svg)