Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 3.14 KB

README.md

File metadata and controls

61 lines (44 loc) · 3.14 KB
Raw

My Gear - Equipment Management App

This My Gear - Equipment Management App is a web application that allows users to track and manage their equipment value. Users can add, edit, and delete equipment entries, as well as search and sort the equipment list. The app provides a user-friendly interface for efficient equipment management.

Table of Contents

Project Overview

The Equipment Management App is designed to simplify the process of tracking and managing equipment inventory. It provides a centralized platform for users to store and organize equipment data, making it easy to access and update information as needed. The app aims to streamline equipment management workflows and enhance efficiency for businesses or individuals with equipment-intensive operations.

Features

  • User authentication: Users can register an account and log in to access their equipment data.
  • Equipment list: Users can view a list of their equipment with details such as serial number, purchase date, and purchase price.
  • Add/edit/delete equipment: Users can add new equipment entries, edit existing entries, and delete equipment from their inventory.
  • Sorting and filtering: Users can sort the equipment list based on specific columns and apply filters to find equipment quickly.
  • Total value calculation: The app automatically calculates the total value of the equipment based on their purchase prices.

Installation

  1. Clone the repository to your local machine.
  2. Install the necessary dependencies using the package manager of your choice.
  3. Set up the environment variables for the server address and other configuration options.
  4. Run the development server.
  5. Repeat steps 1-4 with the server install (https://github.com/sohostory/my-gear-api.git)

Usage

  1. Register an account or log in using your existing credentials.
  2. Once logged in, you will be directed to the dashboard, where you can manage your equipment.
  3. Add new equipment by filling out the required fields and clicking the "Add" button.
  4. Edit or delete equipment by selecting the corresponding options for each entry.
  5. Use the search bar to filter the equipment list based on specific criteria.
  6. Click on column headers to sort the equipment list in ascending or descending order.
  7. Navigate to other sections of the app using the navigation links provided.

Technologies Used

  • React: JavaScript library for building user interfaces
  • Node.js: JavaScript runtime environment
  • Express: Web application framework for Node.js
  • Sequelize: Promise-based ORM for Node.js
  • PostgreSQL: Open-source relational database system
  • Axios: Promise-based HTTP client for the browser and Node.js

Contributing

Contributions to the Equipment Management App are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request following the contribution guidelines.

License

This project is licensed under the MIT License.