README.md

Magic the Gathering Collection - Frontend

Description

This application works in parallel with Magic the Gathering Collection - Backend to provide users a place to create, maintain, and otherwise view their magic card collections as well as the current market value for cards in their collection in USD.

We've leveraged technologies such as React, TypeScript, Material UI, Vite, and playwright to accomplish our goal of creating and testing the Frontend and support the needs of the Backend application.

How to run the project

1. Clone the repository
2. Use NPM to install dependancies
   • npm i
3. Create db.js at the root level of the project with connection to your database
   • Example

     const Pool = require("pg").Pool;
     
     const pool = new Pool({
         user: "{{dbuser}}",
         password: "{{dbpassword}}",
         database: "{{dbname}}",
         host: "{{dbhost}}",
         port: 5432,
         ssl: require
     });
     
     module.exports = pool;

4. Create .env file at the root level of the project
   • Example

     PORT = 3000
     JWT_SECRET_KEY = your_secret_key
     API_TOKEN = test_api_token
     USER = test_username
     PASSWORD = test_password
     ACCOUNTID = test_account_id
     

5. Two options:
   • Use command npm start to run the application
   • OR use Docker related files to create a container for the project to run in isolation
     • requires Docker to be installed on the local machine
       1. docker compose build
       2. docker compose up

Running Tests

This project utilizes playwright for handling api tests. Simply use command npx playwright test to run all test specs or you can specify a spec file to run for example npx playwright test ./tests/login.spec.ts to run all login api tests.

---

Credits

Application code written by Tom Slanda and Rob Kazirut with help from the following:

• Scryfall - Providing up to date card prices

• Geeks for Geeks - JWT Authentication guide

• Playwright - Playwright documentation