/nakama-api

This is a simple Nakama's API built using Hono.js, Prisma ORM and documentation with OpenApi Swagger, will reserve api fot getting data from database for Nakama's store.

Primary LanguageTypeScriptMIT LicenseMIT

Nakama API

This is a simple Nakama's API built using Hono.js, Prisma ORM, and documented with OpenAPI Swagger. It provides endpoints to retrieve data from the database for Nakama's store.

Features

  • Product Management: Managing one-piece merchandise products, including creating, updating, and retrieving product information.
  • Category Management: Managing product categories, including creating, updating, and retrieving category information.
  • Order Management: Managing orders, including creating, updating, and retrieving order information.
  • Search and Filtering: Searching and filtering products based on various criteria, such as price, category, and stock availability.

Tech Stacks

Installation

Follow these steps to get your Nakama API up and running:

  1. Clone the repository and install the required dependencies:

    git clone https://github.com/yourusername/nakama-api.git
    cd nakama-api
    bun install
  2. Create a .env file in the root directory and add the following environment variables:

    DATABASE_URL=postgresql://user:password@localhost:5432/nakama
  3. Run the migrations:

    bunx  prisma migrate dev
  4. Start the server:

    bun run dev
  5. Open your browser and navigate to http://localhost:3100/api to access the API documentation.

Contributing

Contributions are welcome! To contribute to this project, please follow these steps:

  1. Fork the repository on GitHub.

  2. Create a new branch for your feature or bug fix:

    git checkout -b feature/YourFeatureName
    git commit -m "Add some feature"
    git push origin feature/YourFeatureName
    
    

License

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