Skip to content

ArmanKumar456/Chaptered

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

4 Commits
ย 
ย 

Repository files navigation

๐Ÿ“š Chaptered

A social reading platform to track books, build habits, and connect through book clubs.

๐Ÿš€ Live Demo: Coming Soon ๐Ÿ“– Docs: TECHNICAL_PLAN.md

๐ŸŒŸ What is Chaptered?

Chaptered is a full-stack web application designed to make reading more engaging, social, and consistent.

It combines:

๐Ÿ“– Personal reading tracking ๐Ÿ‘ฅ Book clubs & discussions ๐Ÿ“Š Reading analytics

Built as a 7-day MVP, it showcases scalable architecture, real-time features, and modern dev practices using React, Node.js, and MongoDB.

๐Ÿงฉ Features โœ… Current (MVP - Phase 1)

๐Ÿ” Authentication

JWT-based login/signup Secure password hashing Persistent sessions

๐Ÿ“– Reading Tracker

Add books (manual + Google Books API) Track reading sessions (pages + time) Reading streaks & stats

๐Ÿ“Š Dashboard

Active books overview Weekly reading insights Quick session logging

๐Ÿ” Book Discovery

Search via Google Books API One-click add Manual entry support

๐Ÿ‘ฅ Book Clubs

Create/join clubs Invite via code Track member progress

๐Ÿ’ฌ Real-Time Chat

Socket.io powered messaging Persistent history Timestamps

๐Ÿ—ณ๏ธ Book Voting

Suggest books Vote within clubs Auto-select winning book ๐Ÿšง Upcoming (Phase 2) ๐Ÿ’ณ Stripe-based premium tier ๐Ÿค– AI Reading Coach ๐ŸŽฏ Personalized recommendations ๐Ÿง  Spoiler-free discussions ๐Ÿ”ฎ Future Vision (Phase 3+) ๐Ÿ“ฑ Mobile app (React Native) ๐Ÿ“ž Video book club meetings ๐Ÿ”” Push notifications ๐Ÿ† Reading challenges & badges ๐Ÿ› ๏ธ Tech Stack Frontend React 18 + TypeScript Vite Tailwind CSS Zustand React Router Axios Socket.io Client Backend Node.js + Express TypeScript MongoDB + Mongoose JWT Auth Socket.io DevOps Vercel (Frontend) Railway / Heroku (Backend) MongoDB Atlas ๐Ÿ“ Project Structure chaptered/ โ”œโ”€โ”€ chaptered-web/ # React frontend โ”œโ”€โ”€ chaptered-api/ # Node.js backend โ””โ”€โ”€ README.md ๐Ÿš€ Getting Started

  1. Clone Repo git clone https://github.com/yourusername/chaptered.git cd chaptered
  2. Setup Frontend cd chaptered-web npm install npm run dev
  3. Setup Backend cd chaptered-api npm install npm run dev
  4. Environment Variables

Backend .env

PORT=5000 MONGODB_URI=your_mongodb_uri JWT_SECRET=your_secret FRONTEND_URL=http://localhost:5173

Frontend .env.local

VITE_API_URL=http://localhost:5000/api ๐Ÿ“ก API Overview Method Endpoint Description POST /auth/signup Register user POST /auth/login Login GET /auth/me Current user GET /books Get books POST /books Add book POST /books/:id/sessions Log session

๐Ÿ‘‰ Full API: TECHNICAL_PLAN.md

๐Ÿ” Authentication Flow User logs in/signup Backend returns JWT Token stored in frontend Sent via Authorization: Bearer Middleware verifies requests ๐Ÿงช Testing Backend curl http://localhost:5000/api/health Frontend Test signup/login Verify dashboard loads Check API calls in DevTools ๐Ÿš€ Deployment Frontend (Vercel) Connect repo Set VITE_API_URL Deploy Backend (Railway) Add environment variables Deploy via GitHub ๐Ÿค Contributing

We welcome contributions!

Steps git checkout -b feature/your-feature git commit -m "feat: add new feature" git push origin feature/your-feature

Then open a Pull Request ๐Ÿš€

Contribution Guidelines:

  1. Use TypeScript
  2. Follow existing structure
  3. Keep functions small
  4. Write clear commit messages

๐Ÿ› Issues & Support Open an issue for bugs Use discussions for ideas Include reproduction steps

MIT License

๐Ÿ‘ฉโ€๐Ÿ’ป Maintainer

Vanshika Sharma Open to collaborations and contributions!

๐Ÿ’ก Why This Project Matters

Chaptered isnโ€™t just a tracker. Itโ€™s trying to turn reading from a solo habit into a shared experience. Less โ€œbooks gathering dust,โ€ more โ€œstories sparking conversations.โ€

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors