Project README update

[nathanrydel]

Update README to match this template:

Project README Update Issue Template

Overview

Briefly describe the purpose of this update or the issue with the current README that needs addressing.

Screenshots Update

Please include updated screenshots of the application across various breakpoints using https://ui.dev/amiresponsive. This helps in visually demonstrating the application's responsive design. Attach the images below or provide links to where they are hosted.

• Desktop View:
• Tablet View:
• Mobile View:

(Replace the above with actual screenshots or links)

Technologies Section Update

Detail the languages, frameworks, and libraries in use for this project. Include badges for each to quickly convey this information. Below is a template you can customize:

Technologies Used

• Frontend: React
• Backend: Node.js, Express
• Database: PostgreSQL
• Other Libraries:

(Replace the above with actual technologies and badges relevant to project)

Local Setup Instructions

Provide detailed instructions on how to set up the project locally. This includes prerequisites, installation steps, and any environment setup needed.

Prerequisites

• Node.js (version X or above)
• npm (version Y or above)
• PostgreSQL (version Z or above)

Installation

1. Clone the repository:

   git clone https://github.com/yourproject/repository.git
   

2. Navigate to the project directory:

   cd repository
   

3. Install dependencies:

   npm install
   

4. Set up environment variables:
   Create a .env file in the root directory and update it with the necessary environment variables (e.g., database connection string).

Running the Application

1. Start the server:

   npm start
   

2. Open http://localhost:3000 in your browser to view the application.

Database Seeding

Detail the process for seeding the database for development purposes.

Seeding the Database

To seed the database with initial data for development testing, follow these steps:

1. Navigate to the script location:

   cd path/to/seed/script
   

2. Run the seed script:

   node seedScript.js
   

This will populate your database with sample data necessary for development testing.

Testing Instructions

Explain how to run the tests for this project, including any prerequisites for testing.

Running Tests

To ensure the quality and functionality of our application, follow these steps to run the tests:

1. Ensure all dependencies are installed:

   npm install
   

2. Run the test script:

   npm test
   

This will execute all unit and integration tests and display the results.