PieterT2000 / visual-plotly

UI for generating charts with Plotly.js

Team SH27 Main Project - Team Project 3 Course 2023-24

Docs

• Frontend (read 'em, they will save you time 💯)
• Backend (not relevant anymore)

Deployment

• Production
• Staging/develop

Installation

Requirements

• Node.js version > 14.8

• Node.js: Node.js can be downloaded and installed from Node.js Official Website. This will also install npm automatically, which is the package manager for Node.js.

Step-by-step

Follow these steps to set up the project locally:

1. Clone the Repository

   Clone the project repository to your local machine in the directory of your choice:

   git clone https://github.com/PieterT2000/visual-plotly.git

2. Open the Project

   Open the project in your IDE or text editor of choice.

3. Navigate to Frontend Directory

   Using the terminal, navigate to the frontend folder within the cloned project directory:

   cd frontend

4. Install Dependencies

   Install the project dependencies by running:

   npm install

5. Run the Vite Development Server

   Start the development server by executing:

   npm run dev

6. Access the UI

   After starting the development server, open your web browser and access the webpage by clicking on the localhost link provided in the terminal (typically http://localhost:3000 or similar).