Inprocessing Website

Table of Contents

• [Description]
• [Installation]
• [Usage]
• [Removal]
• [Extraneous]

Description

Technologies Used

Front-end

• Framework
  • React _18.2.0
• Routing
  • React Router _6.10.0
• Styling
  • React-Bootstrap _2.7.2
  • MUI Material _5.11.16
• Cookie Management
  • js-cookie _3.0.1

Back-end

• Framework
  • Express _4.18.2
• Database
  • PostgreSQL _8.10.0
• Database/SQL Queries
  • Knex _2.4.2
• Data Mock
  • FakerJS _7.6.0
• Session Management
  • express-session _1.17.3

Endpoints

GET:

• '/table/:name-of-table'
  • gets a specific table by name
• '/table/:name-of-table/:id'
  • gets a specific id of item in a table
• '/tasks-locations'
  • gets a join table of tasks and locations

POST:

• '/tasks'
  • post to the Tasks table. Must have a task_name, due_date, priority, and task_description
• '/locations'
  • post to the Locations table
• '/login'
  • send authentication data to the server
• '/session'
  • send authentication success to server

PATCH:

• '/tasks/:id'
  • update the task with the ID given

DELETE:

• '/tasks/:id'
  • removes the task with the ID given
• '/users/:id'
  • removes the user with the ID given

Containerization

• Docker Desktop _20.10.24

_{Please review the package.json in ./backend & ./frontend folders for a more detailed list of technology dependencies.}

Installation

Quick Start with Docker

_{This installation guide assumes the user has the latest version of Docker desktop installed locally. Installation guide can be found here.}

1. Clone this repository into your local machine with: git clone

2. Navigate to the cloned repo in your local machine.

3. Open the cloned repo in vscode.

4. Open the terminal in vscode.

5. Perform the following command in said terminal: docker-compose up

   _{This should install all dependencies, and perform all boot-up processes.}

6. Wait for the front-end to finish loading, this should be the last container to load before opening the app.

7. Open an instance of Google Chrome or a Chromium browser.

8. Type and search http://localhost:3000/ into the address at the top of the page.

   _{This concludes installation guide.}

Usage

Removal

Run the following command to remove the docker image and container built for this program: docker-compose down --rmi all

Extraneous

Conceptual Wire Frame