Greenline Docs

Appearance

GreenlineDCS ​

GreenlineDCS Logo

GreenlineDCS is a comprehensive shop management solution that empowers you to streamline every aspect of your business operations, including:

  • Managing multiple locations
  • Tracking employee performance
  • Customizing item pricing
  • Inventory management
  • Sales reporting

Prerequisites ​

  • Node.js v18.20
  • Bun (latest version)
  • MySQL
  • Composer
  • PHP v8.2
  • Mailpit

Note: For those using pkgx, we have provided the pkgx.yaml file for easy installation.

Frontend Setup ​

Getting started with Greenline frontend is simple:

bash
git clone https://github.com/Eliinova/greenline.git
cd greenline
bun install

Next, start the development server:

bash
bun run dev

Now, you can open your browser and visit http://localhost:3000 to see the application running.

API Setup ​

Using pkgx ​

Note: for pkgx users, we provide a pkgx.yaml file for easy installation of most dependencies. However, please note that MySQL, Composer, and PHP 8.2 are excluded due to compatibility issues. Improvements are welcome, but soon incoming!

Get Started ​

Follow these steps to get the Greenline API up and running:

bash
git clone <https://github.com/Eliinova/greenline-api.git>
cd greenline-api
composer install

Now, you can start the API development server via:

bash
php artisan serve

Optionally, you can also run Queue workers with:

bash
php artisan queue:work

Open your browser and visit http://localhost:8000 to see the API running.

📚 Documentation ​

For detailed information on how to use GreenlineDCS, please refer to our comprehensive documentation.

🤝 Contributing ​

We welcome contributions! Please see our Contributing Guide for more information.

📄 License ​

GreenlineDCS is licensed under the MIT License.