Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.47 KB

README.md

File metadata and controls

47 lines (33 loc) · 1.47 KB
Raw

BMS: Business Management System Backend

This repository contains the backend for a Business Management System (BMS) built on Node.js, TypeScript, and Prisma with Postgres.

What it is:

  • A back-end API for managing business data
  • Built with:
    • Node.js: JavaScript runtime environment
    • TypeScript: Statically typed superset of JavaScript
    • Prisma: ORM (Object Relational Mapper) for working with Postgres
    • Postgres: Relational database management system
    • Swagger: OpenAPI specification for API documentation

What it does:

  • Provides programmatic access to business data, such as:
    • Customers
    • Products
    • Inventory
    • Sales
  • Enables other applications to interact with the system through well-defined APIs

What it doesn't do:

  • Provide a user interface
  • Handle front-end functionality

Getting started:

  1. Clone the repository
  2. Install dependencies: npm install
  3. Configure connection details for Postgres in .env file
  4. Run the server: npm run start
  5. Explore the API documentation: http://localhost:3000/docs

Contributing:

We welcome contributions! Please see the CONTRIBUTING.md file for guidelines.

Additional information:

  • This is a back-end only project. It does not include any front-end components.
  • The API documentation is generated from the code using Swagger.
  • The project is still under development.

Feel free to open issues or pull requests with any questions, suggestions, or contributions!