https://github.com/t0ks1k24/hackathon_team3
📚 Book catalog web app with authentication, search and book details. Built with React + Django + PostgreSQL.
https://github.com/t0ks1k24/hackathon_team3
books catalog django docker hackthon jwt-auth postgresql python react rest-api
Last synced: about 2 months ago
JSON representation
📚 Book catalog web app with authentication, search and book details. Built with React + Django + PostgreSQL.
- Host: GitHub
- URL: https://github.com/t0ks1k24/hackathon_team3
- Owner: T0ks1k24
- Created: 2025-05-27T11:39:57.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-24T15:17:14.000Z (9 months ago)
- Last Synced: 2025-08-24T20:09:23.718Z (9 months ago)
- Topics: books, catalog, django, docker, hackthon, jwt-auth, postgresql, python, react, rest-api
- Language: Python
- Homepage:
- Size: 1.95 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hackathon_Team3
## 🔹 Book Collection Website
This is a web application for convenient book search and browsing. The site allows users to:
* 🔐 Authenticate (login/register)
* 📖 View books
* 🔍 Search books by title
---
## 🔧 Problem the Website Solves
* 📘 Provides quick access to book information
* 🔍 Allows easy search by title
* 🔐 Provides simple authentication with JWT
* 💻 Offers an intuitive interface (planned improvements)
---
## ✅ Key Features
* 🔐 User authentication (Login) and registration (Register)
* 🏠 Home page with greeting
* 🔒 Automatic redirect to login page if not authenticated
* 📚 Book catalog with pagination
* 📄 Detailed book information view
---
## 🛠️ Technologies Used
### 🔹 Frontend (React)
* ⚛️ **React** — core library for building the UI
* 🔁 **React Router** — page routing
* 🧠 **Redux Toolkit** — centralized state management
* 🎨 **React Icons** — modern styled icons
* 🧰 **Lodash** — utility library for arrays, objects, strings
---
### 🔹 Backend (Django)
* 🐍 **Python + Django 5.2** — backend framework
* 🌐 **Django REST Framework (DRF)** — REST API creation
* 🔐 **Simple JWT** — authentication with JSON Web Tokens
* 🔎 **django-filter** — API request filtering
* 🌍 **django-cors-headers** — CORS support for frontend communication
* 📄 **drf-yasg** — autogenerated API docs (Swagger/OpenAPI)
* ⚙️ **python-dotenv** — load configs from `.env`
* 🌐 **requests** — HTTP requests
* 🧽 **BeautifulSoup4** — HTML/data parsing
* 📊 **pandas + XlsxWriter** — analytics, Excel export
---
### 🔹 DevOps
* 🐳 Docker
* 🐙 docker-compose
* 🌲 git
* 🐱 GitHub
* ⚙️ GitHub Actions
* 🌐 nginx
---
### 🗃️ Database
* 🐘 **PostgreSQL** — relational database for books, users, and more
---
## 2. Installation
You can use Docker to run the project — this makes setup much easier.
### Run with Docker
```bash
cd devops/docker/
docker-compose up -d
```
### Backend (Python / Django)
Ensure you have Python 3.10+ and pip installed.
```bash
cd backend
python -m venv env
# Windows
source env/Scripts/activate
# MacOS/Linux
source env/bin/activate
pip install -r requirements.txt
```
### Frontend (React)
Ensure Node.js and npm are installed.
```bash
cd frontend
npm install
```
---
## 🚀 Running the Project
### Backend (Django)
```bash
cd backend
python manage.py makemigrations
python manage.py migrate
python manage.py runserver
```
### Frontend (React)
```bash
cd frontend
npm start
```
* Frontend → [http://localhost:3000](http://localhost:3000)
* Backend API → [http://localhost:8000](http://localhost:8000)
---
### 🛠️ API Documentation
* Swagger/OpenAPI available at:
[http://localhost:8000/swagger/](http://localhost:8000/swagger/)
⚠️ All protected endpoints require a JWT token in the header:
```
Authorization: Bearer
```
---
## 🧠 Conclusions / Next Steps
🔚 Our site is not yet a full-fledged library, but it’s no longer just a notebook hack. In 4 days we built working authentication, book search, a catalog, and UI — and that’s already a **victory** (small “v”, bold font).
💤 Countless sleepless nights, more coffee than code, and our team mantra:
**“I still know nothing, but I’m already coding!”**
👨💻 Despite teammates being like:
* “team knows nothing yet”
* “team went to sleep”
* “team forgot to push to git”
Everyone contributed — even those who joked more than coded!
---
### 📅 What We Plan to Add
* 💾 Save books to favorites (likes, bookmarks)
* ⭐ Book ratings and reviews
* 📥 Admin panel for manual book adding
* 📦 Parser for new online sources
* 🌗 Dark/light theme (partially done)
* 📱 Mobile adaptation
* 🛡️ More validations and security
---
🎉 The project became more than just code — it was an adventure: bugs, fixes, chaos in Discord, and memes instead of documentation 😄
We learned more than expected, wrote more code than planned, and of course — slept less than we should have.
---