47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
|
# Project Genesis
|
||
|
|
|
||
|
|
A modern, responsive web application built with Vue.js. This project leverages a rich component library for a polished user interface and centralized state management for a robust and scalable architecture.
|
||
|
|
|
||
|
|
## Core Technologies
|
||
|
|
|
||
|
|
- **Framework:** [Vue.js](https://vuejs.org/)
|
||
|
|
- **UI Components:** [PrimeVue](https://primevue.org/)
|
||
|
|
- **State Management:** [Pinia](https://pinia.vuejs.org/)
|
||
|
|
- **API Communication:** [Axios](https://axios-http.com/) (Managed within Pinia stores for centralized API/SPI calls)
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
|
||
|
|
|
||
|
|
### Prerequisites
|
||
|
|
|
||
|
|
You will need [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed on your machine.
|
||
|
|
|
||
|
|
- Node.js (v18.x or higher recommended)
|
||
|
|
- npm (v9.x or higher recommended)
|
||
|
|
|
||
|
|
### Installation
|
||
|
|
|
||
|
|
1. Clone the repository to your local machine:
|
||
|
|
```sh
|
||
|
|
git clone <repository-url>
|
||
|
|
```
|
||
|
|
2. Navigate to the project directory:
|
||
|
|
```sh
|
||
|
|
cd <project-directory>
|
||
|
|
```
|
||
|
|
3. Install the dependencies:
|
||
|
|
```sh
|
||
|
|
npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
To start the local development server, run the following command:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm run dev
|
||
|
|
```
|
||
|
|
|
||
|
|
The application will be available at `http://localhost:5173` (or the next available port). The development server supports hot-reloading, so any changes you make to the source code will be reflected in the browser automatically.
|