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

Clone the Repository

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

Install Backend Dependencies
```
composer install
```
Install Frontend Dependencies
```
npm install
```
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.
Generate Application Key
```
php artisan key:generate
```
Run Database Migrations
```
php artisan migrate
```
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:

Fork the repository.
Create a new branch:
```
git checkout -b feature/your-feature
```
Commit your changes:
```
git commit -m "Add your feature"
```
Push to the branch:
```
git push origin feature/your-feature
```
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!

thefeqy / rilty

Maintainers

Details