SC3040 Advanced Software Engineering Project — 📚 shelvd

📚 shelvd strives to enhance book discovery and foster a vibrant reader community through personalized recommendations, advanced search capabilities, and interactive forums, including virtual book clubs and reader reviews. This web app is the ultimate destination for book lovers seeking to explore new titles and connect with fellow enthusiasts in a dynamic, user-friendly environment.

REST API behind the social network for book lovers.

• Website
• API
• Documentation

---

🛠️ Installation and Set Up

• Clone repository

  git clone git@github.com:crystalcheong/shelvd-api.git
  

• Install dependencies

  bun install
  

Important

Required environment variables

• Duplicate .env.example to create *.env files
  • .env — The default file used to store your dev, production, and test variables
  • .env.local — Overrides all environment files except the test file (including the default .env file)

• Preparing Postgres + Drizzle-ORM

   bun run migrate
   bun run generate
  

• Starting the server The server will start at http://localhost:3000 by default

   bun start:dev
  

---

🧰 Languages & Tools

• Languages & Frameworks
  

• Tools, IDE
  

---

Contributors ✨

Crystal Cheong	Ryu Hyunsun	Zhu Yu Hao
Nyan Maw Htun	Kenneth Goh	Muhammad Sufyan	Arun Ezekiel

---

This repository is submitted as a project work for Nanyang Technological University's SC3040 - Advanced Software Engineering course.