Skip to content

README.md

Latest commit

 

History

History
80 lines (54 loc) · 1.8 KB

README.md

File metadata and controls

80 lines (54 loc) · 1.8 KB

Music Instruments Inventory App

A web application to manage an instruments inventory, built with Express.js and PostgreSQL.

Features

  • Complete Instrument Management: View, add, edit, and delete instruments in your collection
  • Category-based Organization: Group instruments by category (guitars, drums, etc)
  • Security: Password protection for all modification operations

Tech Stack

  • Server: Express.js and Node.js
  • Database: PostgreSQL
  • Views: EJS

Installation

  1. Clone the repository:

    git clone https://github.com/NicoCodesCode/music-instruments-inventory.git
cd music-instruments-inventory

  2. Install dependencies:

    npm install

  3. Set up your PostgreSQL database:

  4. Set up environment variables

  5. Start the application:

    npm run dev

Usage

Viewing Instruments

  • Navigate to the home page to see a complete list of all instruments
  • Click on any instrument to view its detailed information

Adding a New Instrument

  1. Click "Add Instrument" on the navigation bar
  2. Fill in the instrument details
  3. Enter the admin password
  4. Click "Add"

Editing an Instrument

  1. Navigate to the instrument's detail page
  2. Click "Edit"
  3. Modify the information as needed
  4. Enter the admin password
  5. Click "Update"

Deleting an Instrument

  1. Navigate to the instrument's detail page
  2. Click "Delete"
  3. Confirm deletion
  4. Enter the admin password

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.