lutfiandri / teti-lib

Rest API Peminjaman Buku | Kuliah Pengembangan Aplikasi Web

TETI LIB

Rest API Peminjaman Buku | Kuliah Pengembangan Aplikasi Web

Related Repository

• Frontend Repo: https://github.com/lutfiandri/teti-lib-frontend
• Backend Repo: https://github.com/lutfiandri/teti-lib (current)

Links

• Slide Presentasi (UTS): Click Here
• Video Presentasi (UTS): Click Here
• Slide Presentasi (Akhir): Click Here
• Front End: https://teti-library.vercel.app/
• Back End: https://teti-lib.vercel.app/
• Postman Docs: Click Here

⚡️ Development Setup

Prerequisites

• Download and install Node.js version 16.15 or higher.
• Download and install yarn version 1.22 or higher.
• Clone this project and open it using your favorite code editor.

Setting Up Project

• Install required dependencies:

  yarn

• Run the program:

  # on development
  yarn dev
  
  # on production
  yarn start

⚙️ Project Structure

Directory Tree

.
└── teti-lib/
    ├── src/
    │   ├──routes/
    │   ├──controllers/
    │   ├──models/
    │   ├──middlewares/
    │   └──helpers/
    ├── index.js
    └── package.json

Explanation

1. package.json

   Berisi informasi, dependency, dan npm scripts dari project ini.

2. index.js

   Berisi inisialisasi server.

3. src/routes/

   Berisi endpoint dan terkoneksi dengan controller.

4. src/controllers/

   Berisi controller dan terkoneksi dengan service. Semua logic dari aplikasi harus berada pada controller.

5. src/models/

   Berisi model dan schema dari tiap-tiap entity.

6. src/middlewares/

   Berisi express middleware.

7. src/helpers/

   Berisi helper functions.

🗒️ Contribution Guide

Branch Name

<type>/<short_description>

# contoh
feature/get-all-books

<type> :

• feature: saya menambahkan fitur baru
• fix: saya memperbaiki fitur

Learn More

Commit Message (Git Conventional Commits)

<type>(scope): <short_summary>

# contoh
feat(books): get all books service
fix(books): missing variable

Learn More