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
Before proceeding, ensure you have the following installed on your system:
-
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
-
Navigate to the directory of the cloned repository
-
Enter the server folder, and install backend dependencies using npm:
npm install
-
Enter the client folder, and install frontend dependencies using yarn:
yarn install
To start the development server, follow these steps:
-
Open a terminal and navigate to the directory of the cloned repository.
-
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
.
To run the frontend, follow these steps:
-
Open a new terminal window/tab and navigate to the directory of the cloned repository.
-
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
.
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
.
Enjoy! ๐๐๐