From 50533a794fe87356c397915eabd0f35f0a329827 Mon Sep 17 00:00:00 2001 From: Eries Trisnadi Date: Mon, 15 Jan 2018 02:54:47 +0700 Subject: [PATCH] update readme --- readme.md | 101 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 70 insertions(+), 31 deletions(-) diff --git a/readme.md b/readme.md index 1779d6a..0dd4b14 100644 --- a/readme.md +++ b/readme.md @@ -13,48 +13,87 @@

-## Download -The latest version of Storaji for macOS, Linux and Windows is available [here](https://github.com/IndomaximTechID/storaji/releases). +## Downloads +macOS 10.9+ | Windows 7+ | Linux +-----------------| ---| ---| +Download v1.0.0-beta.5 | Download v1.0.0-beta.5 | Download v1.0.0-beta.5 | -**macOS 10.9+, Windows 7+ & Linux are supported.** +[More Download Options](https://github.com/IndomaximTechID/storaji/releases) -#### Latest updates -- (Pre-) Released version 1.0.0-beta.5 -- New Features: (Multiple Order #1, Delete Order, Product Image) -- Bugfix: (filter date #8, Bugfix Report Order, delete not pull the new state) - -#### Previous updates -- (Pre-) Released version 1.0.0-beta.4 -- Using production server -- DB has been migrated to production server (30 Dec, 2017) -- Unlimited bandwidth, Unlimited Database Storage and Fast 24/7! -- **DANGER!** Please update at least to this version or above, if you don't want to lose your data! Beta server has limited database, if the data more than 200mb it will reset all of them. - -[More previous updates](https://github.com/IndomaximTechID/storaji/releases) +## Technologies +- [Electron](https://electronjs.org/) +- [Electron-Builder](https://www.electron.build/) +- [Angular](https://angular.io/) +- [Laravel](https://laravel.com/) +- [UIkit](https://getuikit.com/) +- [Tus](https://tus.io/) ## Features -- Products Management -- Customers Management -- Orders Management and Order Overview -- Multiple Orders -- Statistics -- Top Selling Products -- Customers List on Product Overview -- Reports for Products, Orders, Customers -- Translations for Bahasa Indonesia, English -- Save Report as PDF -- Check for update app +- :zap: Fast!!! +- :sparkles: Friendly UI & UX and Has nice looking window. +- :cloud: Cloud data service. +- :inbox_tray: Products Management. +- :busts_in_silhouette: Customers Management. +- :truck: Orders Management and Order Overview. +- :ship: Multiple Orders. +- :chart_with_upwards_trend: Statistics. +- :top: Top Selling Products. +- :open_hands: Customers List on Product Overview. +- :bookmark_tabs: Reports for Products, Orders, Customers. +- :secret: Translations for Bahasa Indonesia, English. +- :clipboard: Save Report as PDF. +- :100: Check for update app. +- :moneybag: Free! :) + +**If you think Storaji is useful, let me know by putting a star on this project :wink:** ## Screenshots

-## Storaji? -Storaji is an Open Source, Light and/or Responsive Inventory Management System, powered by Electron, Angular 4 and Laravel. Designed for Middle-Low Company to manage their stock if has no much budget to buy License of similar paid software. +## Why +Mainly designed for small-to-medium companies, Storaji is a modern and very intuitive inventory management application built with some of the trendiest web technologies. +Right off the bat, it's worth pointing out that this is by no means a professional software for inventory management. Be that as it may, it can still prove itself fairly useful as it boasts an interesting set of primary features. + +I believe there are many people who needs a simple tool to manage everything from product inventories to orders and of course it's free to use. + +## Development + +#### System Requirements +- NodeJS ^8. +- PHP ^7. +- PHP Composer. + +#### Backend +- Clone the project from [IndomaximTechID/storaji](https://github.com/IndomaximTechID/storaji/) to your local machine. +- Open terminal and `cd` into the cloned folder, usually `cd storaji`. +- Run `composer install` to install dependencies. +- Run `cp .env.example .env` to copy the original environtment variables. +- Modify `.env` file, find `DATABASE_` prefix and change it to your database configuration, you can see documentation about this on [Laravel Site](https://laravel.com/docs/configuration#environment-configuration). +- Run `php artisan key:generate` to generate application key. +- Run `php artisan migrate` to create default database schema of storaji. +- Run `php artisan passport:install` to install default OAuth access token. +- Run `php artisan serve` to run PHP Built-in web server. +- Now your backend is ready to listen request from frontend at `https://localhost:8000/api`. + +#### Frontend +- Clone the project from [IndomaximTechID/storaji-ui](https://github.com/IndomaximTechID/storaji-ui/) to your local machine. +- Open terminal and `cd` into the cloned folder, usually `cd storaji-ui`. +- Modify `app.ts` under `src/app/shared/classes/` directory, and change value of `api` to your local api server, usually `api: 'https://localhost:8000/api'`. +- Run `npm install` to install dependencies. +- Run `npm run ng:serve` to serve the app as web-based at `https://localhost:4200`. +- Now it's ready to use for development. + +**When you have make changes and everything works on angular, and wanna check on desktop app.** +- Run `npm start` to build the app from source and run the app as desktop app. + +**For linting and testing** +- Run `npm test` to check if the source code is passing from linting and testing. + +> This is still in beta and it's far from perfect so feedbacks, issues or PRs are greatly appreciated! :) -## Maintaince -Storaji is currently being maintained by **[lowsprofile](https://github.com/lowsprofile)**. +Note that on Linux you will need additional dependencies to provide the `icns2png` and `gm` commands. Ubuntu/Debian users can run: `sudo apt install -y icnsutils graphicsmagick`. ## License MIT License © 2017-Present [Indomaxim Technology](https://github.com/IndomaximTechID). All rights reserved.