Lockenkey

A modern web application built with Laravel, Vue 3, Inertia.js, and TypeScript, featuring a beautiful UI powered by Tailwind CSS and Radix UI.

Tech Stack

• Backend:

  • Laravel - PHP framework for robust backend development
  • MySQL/PostgreSQL - Database (based on your .env configuration)

• Frontend:

  • Vue 3 - Progressive JavaScript framework
  • TypeScript - For type-safe development
  • Inertia.js - Modern monolithic applications
  • Tailwind CSS - Utility-first CSS framework
  • Radix UI - Unstyled, accessible components
  • Lucide Icons - Beautiful icon set

Prerequisites

• PHP 8.x
• Node.js 18+ and npm/pnpm
• Composer
• MySQL/PostgreSQL

Getting Started

1. Clone the repository:

git clone [your-repository-url]
cd lockenkey

2. Install PHP dependencies:

composer install

3. Install JavaScript dependencies:

npm install

4. Set up environment variables:

cp .env.example .env
php artisan key:generate

5. Configure your database in .env file

6. Run migrations:

php artisan migrate

7. Start development servers:

In one terminal:

php artisan serve

In another terminal:

npm run dev

Development

• npm run dev - Start Vite development server
• npm run build - Build for production
• npm run format - Format code with Prettier
• npm run lint - Lint code with ESLint

Project Structure

• /app - Laravel PHP files
• /resources
  • /js - Vue components and TypeScript files
  • /css - Tailwind CSS and custom styles
• /routes - Laravel routes
• /database - Migrations and seeders
• /config - Application configuration
• /tests - Test files

Contributing

1. Create a new branch for your feature
2. Make your changes
3. Run tests and ensure code quality
4. Submit a pull request

License

[Your chosen license]