Skip to content

Latest commit

 

History

History
92 lines (67 loc) · 4.33 KB

README.md

File metadata and controls

92 lines (67 loc) · 4.33 KB
Raw

Solutions Vault App

React JavaScript TypeScript Vite Postgres Jest Git CSS3 HTML5 MUI Next JS forthebadge forthebadge forthebadge

Overview

The Solutions Vault App is a web application designed to help users manage and organize their problem-solving solutions efficiently. It provides features for creating, editing, and deleting problem entries, as well as categorizing them based on different categories like Front-End, Back-End, or Other. Users can also track the status of each problem, whether it's open or closed.

Features

  1. Problem Management:

    • Create new problem entries with a title, description, solution, category, and status.
    • Edit existing problems to update their details.
    • Delete problems when they are no longer relevant.

  2. Categorization:

    • Categorize problems based on their type, such as Front-End, Back-End, or Other.

  3. Status Tracking:

    • Track the status of each problem, whether it's open or closed.

  4. User Interface:

    • The user interface is intuitive and user-friendly, allowing users to easily navigate and interact with their problem entries.

Technologies Used

  • Frontend:

    • React: Used for building the user interface and managing state.
    • Material-UI: Provides pre-designed React components for building a responsive and visually appealing UI.
    • Next.js: A React framework for server-rendered applications.

  • Backend:

    • Node.js: A JavaScript runtime for building scalable and efficient server-side applications.
    • Express.js: A web application framework for Node.js used for routing and middleware functionality.
    • SQL: A database used for storing problem entries and their details.

Getting Started

To run the Solutions Vault App locally, follow these steps:

  1. Clone the repository: git clone <https://github.com/SolutionVault-Inc/SolutionVault.git>
  2. Navigate to the project directory: cd solutions-vault-app
  3. Install dependencies: npm install
  4. Start the development server: npm run dev
  5. Access the application at http://localhost:3000

Usage

  1. Creating a Problem:

    • Scroll to the "New Problem" form.
    • Fill in the required details such as title, description, solution, category, and status.
    • Click on the "Submit" button to create the problem entry.

  2. Editing a Problem:

    • Click on the "Edit" button next to the problem you want to edit.
    • Update the details as needed.
    • Click on the "Submit" button to save the changes.

  3. Deleting a Problem:

    • Click on the "Delete" button next to the problem you want to delete.
    • Confirm the deletion when prompted.

  4. Categorizing Problems:

    • When creating or editing a problem, select the appropriate category from the dropdown menu.

  5. Tracking Problem Status:

    • Choose the status of each problem as either "Open" or "Closed" when creating or editing.

Contributors

  • Mike Tagg
  • Sean Ryan
  • Haider Ali
  • Sofia Sarhiri

License

This project is licensed under the MIT License.