crystalcheong / shelvd-api

📚 REST API behind shelvd, the social network for book lovers

SC3040 Advanced Software Engineering Project — Shelvd

REST API behind the social network for book lovers.

• Swagger
• Documentation

---

🛠️ Installation and Set Up

• Clone repository

  git clone [email protected]: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.