Skip to content

bobluppes/barhive

Repository files navigation

Barhive

Barhive is an open source project that implements a simple to use distributed point-of-sales (POS) system. This system is fit to be used by small hospitality industry businesses who wan't to adopt a modern sales process without investing in a physical POS system. Barhive is designed to run on any smartphone, table, or laptop.

The aim of the project is to enable business owners all over the world to digitize their bussiness without the upfront investment.

Hacktober

Our current goal is to finish the beta version by the end of October. There are a number of small bugs and two features in the roadmap that need to be fixed/implemented to reach this goal. If you want to contribute to an open source project, feel free to look at the contributing section for more details!

Requirements

Barhive is built in Laravel requires the following to run locally:

Installation

The application is installed like any other Laravel application. It requires composer and npm to be installed.

# Clone the git repository
git clone https://github.com/bobluppes/barhive.git

cd ./barhive

# Install dependencies
composer install
composer update
npm install

# Build sources
npm run dev

Next, the environment variables need to be set. An example configuration can be found in barhive/.env.example, you can simply copy this file to barhive/.env and edit the variables accordingly. The most important settings are the database settings. You will need to create an empty database on your local MySql installation and provide it's name and login credentials to the .env file:

DB_DATABASE=[your_database_name]
DB_USERNAME=[database_username]
DB_PASSWORD=[database_password]

As a last step, artisan is used to get the application up and running.

# Set the application key
php artisan key:generate

# Migrate tables and seed
php artisan migrate
php artisan db:seed

# Serve the application on 127.0.0.1:8000
php artisan serve

Support

For any support with Barhive, you can open an issue on the issue tracker or reach out to me on my github email!

Roadmap

  • Receipt system
  • Payment gateway

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Preferably, pull requests are related to features in the roadmap above or issues in the issue tracker. If a feature on the roadmap has a project board associated, it is added behind the feature in parentheses. See these pages for more information about the planned feature.

Please make sure to update tests as appropriate.

License

MIT

Releases

No releases published

Packages

No packages published

Languages