TDT4140 Gruppe 40 - Flashy

This readme provides documentation for how you can download and test out the product locally.

The product is deployed to tdt-4140-group-40.vercel.app

Prerequisites

Before proceeding, ensure you have the following installed on your system:

• Node.js (includes npm)
• Yarn (for managing frontend dependencies)

Getting Started

1. Clone the repository of our local product to your local machine:

   git clone https://gitlab.stud.idi.ntnu.no/tdt4140-2024/produktomraade-3/gruppe-40/flashy.git
   

2. Navigate to the directory of the cloned repository

3. Enter the server folder, and install backend dependencies using npm:

   npm install

4. Enter the client folder, and install frontend dependencies using yarn:

   yarn install

Launching the Development Server

To start the development server, follow these steps:

1. Open a terminal and navigate to the directory of the cloned repository.

2. Run the following command in the server folder to start the backend server:

   npm start

   This command will launch the backend server, running on http://localhost:5001.

Running the Frontend

To run the frontend, follow these steps:

1. Open a new terminal window/tab and navigate to the directory of the cloned repository.

2. Run the following command in the client folder to start the frontend:

   yarn dev

   This command will compile and launch the frontend application, running on http://localhost:3000.

Accessing the Application

Once both the backend server and frontend application are running, you can access the application by opening your web browser and navigating to http://localhost:3000.

Additional Notes

Enjoy! 🚀🚀🚀