---

BM-Warehouse Server

🚀 Getting Started

Follow these steps to get the project up and running on your local machine:

Prerequisites

• Ensure you have Node.js v20.10.0 installed.
• Ensure you have pnpm installed.

Installation

1. Clone the Repository

   git clone https://github.com/BM-Warehouse/Server.git
   cd Server

2. Duplicate and Configure Environment Variables

   cp .env.example .env

   Make necessary changes in the .env file.

3. Install Dependencies

   pnpm install

4. Set Up Husky

   pnpm prepare:husky

5. Run Database Migrations

   pnpm prisma:migrate

6. Start the Server

   pnpm start

Viewing the Database

To explore the database, run:

pnpm prisma studio

---

🛠️ Available Scripts

Here are some useful scripts you can run:

• Install Dependencies

  pnpm install

• Prepare Husky for Git Hooks

  pnpm prepare:husky

• Run Database Migrations

  pnpm prisma:migrate

• Start the Development Server

  pnpm start

• Run Linter and Unit Tests

  pnpm lint
  pnpm test

• Open Prisma Studio

  pnpm prisma studio

---

📂 Project Structure

A brief overview of the project structure:

• /src: Contains the source code.
• /prisma: Contains Prisma schema and migrations.

---

📄 License

This project is licensed under the MIT License. See the LICENSE file for more details.

---

🌟 Contributing

Contributions are welcome! Please check out the contributing guidelines to get started.

---

For more details, check out our documentation.

---

Happy coding! 🚀

---