Advanced Search
Search Results
27 total results found
College Project - Inventory System Documentation
Documentation on the Inventory Management System. Created for keeping track of "things".
Project Overview
Provides a comprehensive introduction to the Inventory Management System, outlining its purpose, target audience, and the overall architecture. This chapter includes diagrams and explanations of how different components interact, offering a high-level understa...
User Documentation
Serves as a user guide for individuals and households using the system. It includes step-by-step instructions on accessing the web interface, creating accounts, managing nodes (items or categories), and utilizing the user interface effectively. Troubleshooting...
API Documentation
Offers detailed information on the GraphQL API, enabling developers and advanced users to interact with the system programmatically. This chapter covers accessing the API documentation, GraphQL schema details, interactive playground usage, code examples, and a...
Deployment Documentation
Provides instructions and guidelines for deploying the Inventory Management System. It covers prerequisites, installation steps, configuration options, and best practices for deploying to production environments, including security considerations and optimizat...
Development Documentation
Aimed at developers contributing to the project, this chapter details how to set up the development environment, explains the directory structure, outlines coding standards for C++ and Node.js, and shares best practices and tips to avoid common pitfalls during...
Contribution Guidelines
Outlines the process for contributing to the project, including how to fork the repository, create feature branches, write commit messages, and submit pull requests. It also covers code review guidelines, issue reporting procedures, and the project's code of c...
Testing and CI/CD
Describes the testing strategies and frameworks used in the project, including unit, integration, and end-to-end testing. It explains how to write effective tests and details the setup of continuous integration and continuous deployment pipelines, including au...
Security Documentation
Focuses on the security aspects of the system, including authentication mechanisms, session management, audit logging, and data protection measures. This chapter provides details on how the system safeguards user data and maintains secure operations.
SCRUM and Project Management
Covers the SCRUM methodology as applied to the project, detailing roles, ceremonies, sprint planning, task tracking, and communication protocols. It serves as a guide for project management and team collaboration.
Additional Resources
Includes supplementary information such as a glossary of terms and acronyms, a changelog documenting significant project changes, licensing information, and a list of third-party libraries with their versions and licenses.
Suggestions for Testing and CI/CD Pipelines
Provides recommendations on implementing automated testing and setting up CI/CD pipelines. This chapter discusses tools and best practices for ensuring consistency and reliability in testing and deployment processes.
Next Steps
Outlines actionable steps for the team, including assigning documentation tasks, setting up the documentation platform, implementing contribution guidelines, establishing testing protocols, planning CI/CD integration, and scheduling SCRUM meetings for continuo...
Flutter Bootstrap (With Android Emulation)
Source: https://docs.flutter.dev/get-started/install/windows/mobile Download and install the Windows version of the following packages: Git for Windows 2.27 or later to manage source code. Android Studio 2023.2.1 (Iguana) or later to debug and compile Jav...
Introduction
Welcome to the Inventory Management System The Inventory Management System is designed to provide a quick and easy way to set up and run a local inventory management solution. Tailored for individuals and households with multiple users, it enables efficient t...
Architecture Diagram
System Architecture Overview The Inventory Management System consists of three main components: Front End: A Node.js application providing the web user interface. API: A C++ application implementing the GraphQL API and business logic. Database: A Postgre...
Step-by-Step Data Interaction
Understanding Data Flow This section provides a detailed walkthrough of the data flow within the system when a user performs common actions. We'll use the example of adding a new node (item or category) to illustrate the process. Data Interaction Steps 1. U...
Getting Started Guide
Page 2.1.1: Accessing the Web Interface Introduction Welcome to the Inventory Management System! This guide will help you access the web interface so you can start managing your inventory efficiently. Prerequisites System Setup: Ensure that the Inventory...
User Enrollment
Page 2.2.1: Enabling User Enrollment Introduction User enrollment allows individuals to create their own user accounts, which is particularly useful in environments where multiple people need access to the inventory system. Administrators can enable or disab...
Administrative User Management
Introduction Administrators have full control over user accounts within the system. This includes creating new users, editing existing accounts, resetting passwords, and managing user roles and permissions. Accessing User Management Log In as Administra...
Authentication and Sessions
Page 2.3.1: User Accounts Introduction User accounts provide personalized access to the Inventory Management System, enabling individual tracking, permissions, and a tailored experience. Understanding how user accounts work is essential for both users and ad...
Node Management
Page 2.4.1: Adding Nodes Introduction Nodes are the fundamental units within the Inventory Management System, representing items, categories, or any entities you wish to track. Adding nodes allows you to build your inventory structure. Steps to Add a Node ...
User Interface Overview
Page 2.5.1: User Interface Overview Introduction The user interface is designed to be intuitive and responsive, enabling you to navigate and manage your inventory effectively. Familiarizing yourself with its components will enhance your user experience. Mai...
Troubleshooting
Page 2.6.1: Common Issues and Solutions Issue 1: Unable to Access the Web Interface Possible Causes The server is not running. Incorrect URL or port. Network connectivity problems. Solutions Check Server Status: Ensure that the server or D...
Overview
Page 3.1.1: API Overview Introduction The Inventory Management System provides a comprehensive GraphQL API that allows developers to interact with the system programmatically. The API enables you to perform all the actions available through the web interface...
Accessing the API Documentation
Page 3.2.1: Accessing the API Documentation Introduction The API documentation provides detailed information about the available GraphQL types, queries, mutations, and subscriptions. It also includes an interactive playground where you can test API calls dir...
Features
Page 3.3.1: GraphQL Schema Details Introduction The GraphQL schema defines the types, queries, mutations, and subscriptions available in the API. Understanding the schema is crucial for effective interaction with the API. Subsection 3.3.1.1: Types Page 3...