A Vue.js application that generates interactive treemap graphics using data from various sources.
To set up the project, follow these steps:
- Clone the repository:
git clone https://github.com/vmwavie/tree-map.git
- Navigate to the project directory:
cd tree-map
- Install the dependencies:
npm install --force
- Setup your API_KEY on /src/api/brapi/index.ts
- Get on https://brapi.dev/dashboard
public
: Contains static assets such as theindex.html
file and thefavicon.ico
image.src
: The main source code directory, containing the Vue components, views, and various utility files.tests
: Directory for unit tests.
To run various tasks, use the following npm scripts:
npm run serve
: Starts the development server for your Vue.js application.npm run build
: Compiles your Vue.js application for production.npm run test:unit
: Runs unit tests for your Vue.js application.npm run lint
: Runs ESLint to check your code for potential errors and stylistic issues.docker compose up
: Builds and runs the application using Docker Compose. The application will be accessible athttp://localhost:8080
. I hope this improved documentation helps you understand and contribute to the project!