Getting Started - digitalcityscience/TOSCA-2 GitHub Wiki
Getting Started
This guide will help you set up and run the project locally. Follow these steps to install dependencies, configure the environment, and start development.
Prerequisites
Before setting up the project, ensure you have the following installed:
- Node.js (LTS version recommended)
- npm (comes with Node.js) or pnpm (optional)
- Git (for version control)
To verify installation, run the following commands:
node -v # Should return Node.js version
npm -v # Should return npm version
git --version # Should return Git version
Installation
-
Clone the repository
git clone https://github.com/digitalcityscience/TOSCA-2.git cd TOSCA-2
-
Install dependencies
npm install # or use pnpm # pnpm install
Running the Development Server
To start the development server, run:
npm run dev
This will start a local server, and the output will display the URL where the app is running (default: http://localhost:5173
).
Project Structure Overview
📦 project-root
┣ 📂 public # Static assets
┣ 📂 src # Application source code
┃ ┣ 📂 components # Reusable Vue components
┃ ┣ 📂 core # Core utilities and helpers
┃ ┣ 📂 router # Vue Router configuration
┃ ┣ 📂 store # Pinia state management
┃ ┣ 📂 views # Page-level components
┃ ┣ 📜 main.ts # Entry point of the app
┣ 📜 package.json # Project dependencies
┣ 📜 tsconfig.json # TypeScript configuration
┣ 📜 vite.config.ts # Vite configuration
For a detailed explanation of each directory, refer to the Folder Structure page.
Building for Production
To build the project for production, run:
npm run build
The output will be placed in the dist/
folder.
You are now ready to start developing! Explore the documentation further for more details on various project aspects.