# Use and adapt roshn-reit

Use the documented interfaces and source layout for **roshn-reit**. The sections below retain the README’s examples and configuration details.

## Highlights

- Arabic and English language switch with persisted preference
- RTL/LTR document direction switching
- Animated splash screen and page transitions
- Responsive hero with video desktop background and mobile artwork
- Project catalogue with filters and deep detail pages
- Project gallery lightbox and Three.js model viewer
- ScrollTrigger entrance and parallax animations
- Contact form validation and success animation

## Routes

| Route | Purpose |
| --- | --- |
| `/` | Animated landing page |
| `/projects` | Filterable project catalogue |
| `/projects/:id` | Project details, gallery, map, model viewer, and inquiry form |
| `/about` | Company story, mission, stats, and team |
| `/why-us` | ROSHN advantages and testimonials |
| `/contact` | Contact form and company contact details |

## Screenshots

These screenshots were captured with Playwright at a wide desktop viewport after the splash and section animations settled.

### Animated hero

![ROSHN animated hero](https://raw.githubusercontent.com/Up-to-code/roshn-reit/main/docs/screenshots/home-hero-wide.png)

### Project section

![ROSHN project section](https://raw.githubusercontent.com/Up-to-code/roshn-reit/main/docs/screenshots/home-projects-wide.png)

### About Us

![ROSHN About Us page](https://raw.githubusercontent.com/Up-to-code/roshn-reit/main/docs/screenshots/about-wide.png)

### Project details

![ROSHN project details page](https://raw.githubusercontent.com/Up-to-code/roshn-reit/main/docs/screenshots/project-details-wide.png)

### Contact

![ROSHN contact section](https://raw.githubusercontent.com/Up-to-code/roshn-reit/main/docs/screenshots/contact-wide.png)

## Commands in the root manifest

The captured [package.json](https://github.com/Up-to-code/roshn-reit/blob/HEAD/package.json) declares the following scripts. Run them from the directory containing that manifest.

| Command | Script |
| --- | --- |
| `npm run dev` | `vite` |
| `npm run build` | `vite build` |
| `npm run lint` | `oxlint` |

## Troubleshoot a local change

1. Reproduce the smallest example from the [quick-start guide](/docs/up-to-code-roshn-reit/quick-start-guide).
2. Compare required configuration and dependency versions with the README.
3. Check the linked issue tracker for the same error. Include the command, runtime version, and relevant error when reporting a problem; omit credentials.

## Source and help

- [GitHub repository](https://github.com/Up-to-code/roshn-reit)
- [Original README](https://github.com/Up-to-code/roshn-reit/blob/main/README.md)
- [Issues and existing reports](https://github.com/Up-to-code/roshn-reit/issues)
- [Open the project website](https://roshn-reit.vercel.app)