KSA-ORACLE/README.md
Nyavokevin f96ec3d299
Some checks failed
linter / quality (push) Has been cancelled
tests / ci (push) Has been cancelled
first commit
2025-09-02 10:31:17 +03:00

77 lines
1.5 KiB
Markdown

ORACLE
A modern web application built using the powerful combination of Laravel for the backend and Vue.js for the frontend, with Inertia.js serving as the seamless bridge between them. This project leverages TypeScript for enhanced developer experience and type safety across the stack.
Technologies Used
Backend: Laravel
Frontend: Vue.js 3
Server-Side Rendering & Routing: Inertia.js
Language: TypeScript
Package Management: Composer & NPM
Getting Started
Follow these steps to set up the project on your local machine.
Prerequisites
PHP >= 8.1
Node.js >= 16
Composer
NPM
A database (e.g., MySQL, PostgreSQL)
Installation
Clone the repository:
git clone [your-repository-url]
Navigate into the project directory:
cd ORACLE
Install PHP dependencies:
composer install
Install NPM dependencies:
npm install
Create and configure the environment file:
cp .env.example .env
Open the newly created .env file and update the database configuration to match your environment.
Generate an application key:
php artisan key:generate
Run database migrations:
php artisan migrate
Usage
Development
To run the application in development mode with hot-reloading for your frontend assets:
npm run dev
Serving the Application
Once your frontend assets are compiled, you can serve the Laravel application:
php artisan serve
You can now access the application at http://127.0.0.1:8000 (or the URL specified in your .env file).
License
This project is open-source software licensed under the MIT license.
README.md generated for the first commit of the ORACLE project.