README

⚠️ Beta Release
Rilty is under active development. Frequent updates and breaking changes may occur.

Rilty is a modern, full-stack starter kit designed to accelerate your web development projects. Built with cutting-edge technologies, Rilty provides a solid foundation for creating dynamic, responsive, and scalable applications.

Features

Rilty combines the best tools in the ecosystem to ensure a smooth and productive development experience:

• Laravel 11: A robust backend framework for building powerful APIs and applications.
• ReactJS: A modern library for creating interactive and reusable UI components.
• InertiaJS: Simplifying SPA development with a seamless bridge between backend and frontend.
• TypeScript: Adding type safety and better tooling to JavaScript.
• TailwindCSS: A utility-first CSS framework for rapid UI development.

Installation

Follow these steps to get started with Rilty:

Prerequisites

Ensure the following are installed on your system:

• PHP 8.3+
• Composer
• Node.js & npm
• Git

Steps

1. Clone the Repository

   git clone https://github.com/your-username/rilty.git my-project
   cd my-project

2. Install Backend Dependencies

   composer install

3. Install Frontend Dependencies

   npm install

4. Set Up Environment Copy the example environment file and configure it:

   cp .env.example .env

   Update the .env file with your database and application details.

5. Generate Application Key

   php artisan key:generate

6. Run Database Migrations

   php artisan migrate

7. Start the Development Server Start both the backend and frontend servers:

   php artisan serve
   npm run dev

File Structure

Rilty is organized to ensure clarity and maintainability:

my-project/
├── app/                # Backend application logic (Laravel)
├── resources/
│   ├── js/            # Frontend code (React + Inertia)
│   ├── views/         # Blade templates
├── public/            # Public assets
├── database/          # Migrations, Seeders
├── routes/            # API and web routes
└── ...

Scripts

• Development Mode: Start the development servers:

  npm run dev

• Build for Production: Compile assets for production:

  npm run build

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/your-feature

3. Commit your changes:

   git commit -m "Add your feature"

4. Push to the branch:

   git push origin feature/your-feature

5. Open a pull request.

License

Rilty is open-source software licensed under the MIT license.

Support

If you encounter any issues or have questions, feel free to open an issue in the repository or contact thefeqy@gmail.com.

Happy coding with Rilty!