README.md

Packing List App

Table of Contents

• Description
• Installation Instructions
• Usage and Screenshots
• Technologies Used
• Dependencies and Credits
• Project Structure

Description

I created this app as part of the curriculum for The Odin Project. Originally I was planning to do a store inventory but thought that this packing list would be more useful for me in the future.

Installation Instructions

1. Clone or fork this repo
2. cd into the project root directory (where the README.md file is located)
3. Run the following in your terminal

   • npm init -y
     npm install 

4. Create a .env file

   • PORT="3000" (or any even 4 digit integer)
     ROLE_NAME= (database role name)
     ROLE_PASSWORD= (database role password)
     DATABASE_NAME= (database name)
     DATABASE_URL= (URL if remote database)

5. npm run dev

   • ^ + c will end the process

Usage and Screenshots

To create a new item click on the "+ Add new item" button. An existing item can be edited by clicking the "Edit" button on the far right side.

• Link to live preview

Features

• Allows users to add items to more than one category so that the same item can be used in multiple places
• Items can be edited
• Items can be marked as worn

Technologies Used

Frontend

• EJS
• JavaScript
• HTML
• CSS

Backend

• Node.js
• Express

Development Tools

• VS Code
• NPM
• Git

Hosting

• Github
• Render

Dependencies and Credits

Package Dependencies

• cors
• dotenv
• express-validator
• pg

Other Credits

• Devicion
• Skillicons
• LighterPack

Project Structure

├──controllers/            # Controller function
├──db/                     # Mock database using JavaScript files
├──public/                 # Locally hosted image files
├──routes/                 # Router file
└──views/                  # Files to generate pages with EJS
    └── partials/          # Partial EJS