Skip to content

Latest commit

 

History

History
83 lines (54 loc) · 4.28 KB

README.md

File metadata and controls

83 lines (54 loc) · 4.28 KB
Raw

AtlasBooks 📚

en

Welcome to AtlasBooks! 🎉

AtlasBooks is a web-based library platform designed to let users upload, download, rate, and comment on books in a seamless and collaborative environment. Inspired by Z-Library, this project demonstrates our skills in full-stack development, emphasizing quality, usability, and performance.

🚀 Check out the live demo here!

Note

This repository contains the backend code for AtlasBooks, built with the PERN stack (PostgreSQL, Express, React, and Node.js).

Documentation

Index to backend documentation files

  1. Get Started: Instructions on how to set up and run the project locally.
  2. On Project Architecture: Detailed explanation of the project's architecture and design patterns.
  3. API Documentation Strategy: Guidelines on how to document API endpoints using Swagger.
  4. API Version Strategy: Explanation of the API versioning approach used in the project.
  5. On Testing Strategy: Overview of the testing strategy, including unit, integration, and end-to-end tests.

🌟 Key Features

📄 User Profiles

  • User Registration & Authentication: Secure login with JWT.
  • Personalized Profiles: Manage name, email, country, and more.
  • Download History: View all previously downloaded books.

🏠 Home Page

  • Recommended Books Feed: Curated suggestions based on user preferences.
  • Advanced Search: Filter books by author, title, genre, and publication date.
  • Full-Text Search: Leverage ElasticSearch for advanced full-text searches within book content and metadata, ensuring precise and fast results.

📚 Book Management

  • Upload Books: Drag-and-drop functionality for book files and cover images.
  • Book Pages: Download, rate, comment, and share books directly from their dedicated pages.
  • Recommendations: Personalized suggestions based on your downloads and book lists.
  • Report Books: Flag inappropriate content to maintain a quality library.

📋 List Management

  • Create Lists: Organize your reading journey with custom book lists.
  • Public Lists: Share your lists with the community or explore others' collections.

Admin Options

  • User Management: Ban/unban users violating platform policies.
  • Reports Dashboard: Address flagged books and user issues effectively.

🛠 Tech Stack

  • Frontend: Built with React.js and Vite, emphasizing responsive and accessible design using modern CSS techniques.
  • Backend: Developed using Node.js and Express for robust API handling.
  • Database: PostgreSQL powers efficient data storage and management.
  • Search Engine: ElasticSearch for powerful full-text search capabilities.

Other Tools

  • Jira: Agile project management to track progress.
  • Figma: UI/UX design tools for creating an intuitive user interface. Explore the design here

📝 Installation & Contribution

We welcome contributions to enhance AtlasBooks! 🚀 Please review our contributing guidelines for detailed instructions on setting up the project and submitting pull requests.

👩‍💻 Team Members

Meet the passionate team behind AtlasBooks: