/book-reselling

Primary LanguageTypeScriptMIT LicenseMIT

Book Reselling Website Documentation

Welcome to the documentation for the Book Reselling Website built with Next.js! This repository contains the source code and documentation for the website, designed to help users buy and sell books.

You can checkout the live demo. live demo

Table of Contents

  1. Getting Started
  2. Features
  3. Project Structure
  4. Technologies Used
  5. Contributing
  6. License

Getting Started

  1. First, clone the Project
git clone https://github.com/k8pai/book-reselling.git
  1. Then, install the dependencies
npm install
# or
yarn add
# or
pnpm add
# or
bun install
  1. Finally, run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
  1. .env you need to know, should have...
DATABASE_URL="mongodb://localhost:27017" // or connect to your database for development purposes.
NEXTAUTH_SECRET='' // generate a secret from https://generate-secret.vercel.app/64
NEXTAUTH_URL='http://localhost:3000'

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Features

  • Feature 1 - Login

    • Users will be able to log in to the system.
    • User will be directed on the landing page after logging in which will have Purchasing Order page or List of Books Page.

  • Feature 2 - Registration

    • Users will be able to Register into the system.
    • User will be directed on the login page after registration.

  • Feature 3 - List Book

    • User Can See List of Books.
    • User Can View selected book details.
    • User Can Search Book by Categories and Sub-Categories.

  • Feature 4 - Post Book

    • Seller can Add books in the list.
    • Seller get notification after book purchased by Buyer.

  • Add ons...

    • Sellers can Delete the post that they added.
    • ...

Project Structure

There are a couple of folders in the project like /app, /components, /lib, /prisma, /public and /types. All are explained in detail below. It would be helpful to understand how Nextjs works, if youre new to it!

Route (app)
┌ λ /
├ ○ /_not-found
├ λ /api/auth/[...nextauth]
├ ○ /api/books
├ λ /api/books/[id]
├ λ /api/listbook
├ λ /api/register
├ λ /api/sellings/[id]
├ ○ /login
├ ○ /product
├ λ /product/[id]
├ λ /profile
├ ○ /profile/sell
└ ○ /signup

○  (Static)   prerendered as static HTML
λ  (Dynamic)  server-rendered on demand using Node.js

Route (components)
┌ ✧ /primitives
└ ✧ /ui

✧  (Client Components)   Rendered as on the client side.

Route (lib)
┌ :･ﾟ /auth
├ ◕  /data
└ ✪  /prisma

:･ﾟ - Contains auth config files for login and authentication.
◕  - Data for mocking database fetch for fields like filter, sortby etc.
✪  - Prisma singleton initialization file.

Route (root)
┌ :･ﾟ /...
├ ⌁  /prisma
├ ⌀  /public
└ ⁙  /types

:･ﾟ - Rest of the defined folders (already mentioned).
⌁  - Contains schema models of prisma client.
⌀  - Usual public folder for assets and global accessible files.
⁙  - type configurations for authorization callbacks and sessions.

Technologies Used

Contributing

If you'd like to contribute to this project, please follow the guidelines outlined in the CONTRIBUTING.md file.

License

This project is licensed under the MIT License.