README.md

Book Searcher - open source app for searching books.

Project Overview 🎨

Book Searcher is an app to help me (and others 😁) search suitable book from my library. It includes authentication, so every user can create own account. In CRUD panel we can create or move books, but not only. Users can add book to their library and later find them in my books section. Feel free to open an issue if you find bug or something strange. Enjoy!

Tech/framework used 🧰

• Common

Tech	Description
Eslint	Javascript Linter
Prettier	Code formatter
Turborepo	Tool for managing projects with multiple packages

• Frontend

Tech	Description
Typescript	Javascript superset language
Vue 3	Progressive JavaScript Framework
SCSS	CSS with superpowers
Vue Router	Official router for Vue.js
Vee-Validate	Form Validation for Vue.js
GSAP	Professional-grade JavaScript animations for the modern web
Yup	Schema builder for value parsing and validation.

• Backend

Tech	Description
Node	JavaScript runtime
Express	Web framework to Node.js
Typescript	Javascript superset language
Express session	Simple session middleware for Express
Nodemailer	Email sending in Node.js
Cloudinary	Helpful with uploading images
Joi	Library for validation
Docker	An open platform for developing, shipping, and running applications
PostgreSQL	Relational database
Prisma	ORM for TypeScript and Node.js

Performance 💨

Installation 💿

git clone https://github.com/Bartek532/book-searcher.git

yarn install

#set up your environment variables
cp apps/server/.env-sample apps/server/.env
cp apps/client/.env-sample apps/client/.env

docker-compose up

docker exec -i book-searcher-db psql -U librarian -d book-searcher < DUMP.sql #import data to database

yarn dev

Live 🎆

https://book-searcher.vercel.app