Invento is a simple and internal Inventory Management System for Tyreworld Uganda (a fictional company). Tyreworld Uganda sales tyres for all sorts of vehicles. It also offers some services related to the tyres they sale. An example is tyre fitting. So when a customer for example buys tyres, they may also request for the service of fitting the tyre. This service may be an after sale service or paid for separately. Major goal of the system is to keep track of the movement of the stock. Management would like to be notified especially when item stock levels are low or critical. The company has two branches. However, stock is centrally managed at the Main branch.
To keep the project basic, it only rotates around 4 basic entities i.e. users, items, services and sales. Your implementation may not necessarily be limited to those. 1. System will have both staff and customers as system users. However, only staff members will be able to access system pages. Customers on the other hand are simply recorded for the completeness of the data in the system. It's probable that the customers will have access to the system later in the future. 2. There will be only 3 staff user roles i.e. Admin, Data Entrant. Data Entrant can only insert and view listings or details of a particular item or sale record. An Admin can do anything except deleting their own user account. It would actually be nice for an Admin not see the delete button on their own profile. 3. A service has 1 or more items attached to it. Such items may be required or optional in fulfilling the service. The items attached to a service form the cost of the service. The price of the service is basically cost of items + cost of labor. When recording service sale, items attached to the service but marked as optional will increase the final price of the service. 4. For each item in the inventory, the following details will need to be kept: code (string) , size (string) , name (string) , cost (float) , saleable (boolean) , quantity (integer) , minimum_quantity and brand . The name can either be generated or input directly by the data-entrant. When generating name of the item, use the size, code and brand - in that order. For example for a tyre 17' TH4212 Pirelli , 17' is the size, TH4212 is the code and Pirelli is the brand. minimum_quantity refers to the minimum stock quantity required at the shop. saleable simply informs whether the items is sold directly to a customer or not. Most items that are not sold directly to a customer are usually attached to a service. 5. Whenever a sale is recorded, the quantity should always be updated. When the stock quantity reaches or is below the minimum_quantity , the items should be flagged as running out of stock. Show a paginated list of items that are running out of stock on the dashboard. Items that are completely out of stock i.e quantity = 0 cannot be added to a sale record. 6. Show basic reports as follows: a. On the dashboard: Total sales revenue (current month only), A count of sales (current month only), Count of Items. Count of Items Out of Stock. b. On the item details page: Total sales revenue (current month only), A count of sales (current month only) from the specific item being viewed. c. On the customer details page: Total sales revenue (current month only), A count of sales (current month only) to the specific customer being viewed. d. On the staff details page: Total sales revenue (current month only), A count of sales (current month only) by the specific staff being viewed. 7. It's assumed that the developer will take care of all the necessary CRUD operations, decide on the database structure and User Interface. For the UI, feel free to use a simple library of your choice. Bootstrap alone, for example, is good enough without need for Vue.js or Reactjs or similar. Bonus Credit 1. Whenever an item runs out of stock, send a notification to the Manager. 2. Send a notification to the Manager every end of the week (probably every Saturday noontime) for all items that are running out of stock. 3. Even when project is not completed in the allocated time, developer shows that they handled the most important parts of the project first. 4. Use PHP and Laravel best practices in the implementation of the project. Additional Information 1. The UI is not key to the credits on the project, so do not spend much time on it especially if it affects the time needed to accomplish the main requirements of the project. 2. You are expected to create a GitHub Repository for your project. Copy the contents of this PDF file and replace the contents of the README.md file of your repository. Should you have any questions, feel free to raise it as an issue on your project repository. Invite jmatembu , derrickwa , and SsemcoCoder as collaborators to your repository. The collaborators will follow the code you are pushing, review and create issues where necessary. Please commit and push your work regularly to enable the collaborators to follow along. 3. Minimum version to use is Laravel 5.8, and use migrations to manage your database structure. 4. Document any assumptions while implementing the project. Assumptions should however be minimal
You are expected to complete this project within 1 week. Deadline is thus 27-01-2020 at 5pm EAT.