Skip to content

Latest commit

 

History

History
51 lines (43 loc) · 1.33 KB

README.md

File metadata and controls

51 lines (43 loc) · 1.33 KB

Hyprstock

Hyprstock is a hyperlocal inventory management platform enhanced with AI to manage inventory and provide product demand suggestions. The backend is powered by Cloudflare Workers, and the frontend is built with React and Tailwind CSS.

Table of Contents

  • Features
  • Technologies
  • Installation
  • Usage
  • Contributing
  • License

Features

  • Inventory management for hyperlocal features
  • AI-based product need and demand suggestions

Technologies

  • Backend: Cloudflare Workers
  • Frontend: React, Tailwind CSS
  • Other: JavaScript, CSS, HTML

Installation

Prerequisites

  • Node.js
  • Bun (JavaScript runtime)

Steps

1.Clone the repository:

git clone https://github.com/Arnab-Afk/hyprstock.git
cd hyprstock
cd hypr

Install dependencies:

bun install

Run the development server:

bun run dev

Deploy the application:

bun run build

Usage

The main backend logic is located in the root folder, leveraging Cloudflare Workers. The frontend interface is in the hypr directory, built with React and Tailwind CSS. Follow the installation steps to set up the project locally.

Contributing

Contributions are welcome! Please fork the repository and create a pull request with your changes. Ensure your code adheres to the project's coding standards and includes appropriate tests.