|
1 | | -# Welcome to your Lovable project |
2 | | - |
3 | | -## Project info |
4 | | - |
5 | | -**URL**: https://lovable.dev/projects/500696ef-1d19-408f-9ad6-18bfebe05908 |
6 | | - |
7 | | -## How can I edit this code? |
8 | | - |
9 | | -There are several ways of editing your application. |
10 | | - |
11 | | -**Use Lovable** |
12 | | - |
13 | | -Simply visit the [Lovable Project](https://lovable.dev/projects/500696ef-1d19-408f-9ad6-18bfebe05908) and start prompting. |
14 | | - |
15 | | -Changes made via Lovable will be committed automatically to this repo. |
16 | | - |
17 | | -**Use your preferred IDE** |
18 | | - |
19 | | -If you want to work locally using your own IDE, you can clone this repo and push changes. Pushed changes will also be reflected in Lovable. |
20 | | - |
21 | | -The only requirement is having Node.js & npm installed - [install with nvm](https://github.com/nvm-sh/nvm#installing-and-updating) |
22 | | - |
23 | | -Follow these steps: |
24 | | - |
25 | | -```sh |
26 | | -# Step 1: Clone the repository using the project's Git URL. |
27 | | -git clone <YOUR_GIT_URL> |
28 | | - |
29 | | -# Step 2: Navigate to the project directory. |
30 | | -cd <YOUR_PROJECT_NAME> |
31 | | - |
32 | | -# Step 3: Install the necessary dependencies. |
33 | | -npm i |
34 | | - |
35 | | -# Step 4: Start the development server with auto-reloading and an instant preview. |
36 | | -npm run dev |
| 1 | +# JODAZ DEV Website |
| 2 | + |
| 3 | +Welcome to the official repository for **JODAZ DEV**, a premium digital presence and software development platform. This project is built with a focus on performance, modern aesthetics, and a seamless multi-language experience. |
| 4 | + |
| 5 | +## 🚀 Technology Stack |
| 6 | + |
| 7 | +This project leverages cutting-edge web technologies: |
| 8 | + |
| 9 | +- **Framework**: [Astro 5](https://astro.build/) (Static Site Generation) |
| 10 | +- **UI Library**: [React 18](https://reactjs.org/) (via Astro Islands) |
| 11 | +- **Styling**: [Tailwind CSS](https://tailwindcss.com/) |
| 12 | +- **Components**: [shadcn/ui](https://ui.shadcn.com/) |
| 13 | +- **Animations**: [Motion](https://motion.dev/) |
| 14 | +- **Internationalization**: i18next with Astro i18n support |
| 15 | +- **Icons**: [Lucide React](https://lucide.dev/) & [React Icons](https://react-icons.github.io/react-icons/) |
| 16 | + |
| 17 | +## 🛠️ Getting Started |
| 18 | + |
| 19 | +### Prerequisites |
| 20 | + |
| 21 | +- **Node.js**: v18.17.1 or higher |
| 22 | +- **pnpm**: v8 or higher (Recommended) |
| 23 | + |
| 24 | +### Local Development |
| 25 | + |
| 26 | +1. **Clone the repository**: |
| 27 | + ```sh |
| 28 | + git clone <repository-url> |
| 29 | + cd website |
| 30 | + ``` |
| 31 | + |
| 32 | +2. **Install dependencies**: |
| 33 | + ```sh |
| 34 | + pnpm install |
| 35 | + ``` |
| 36 | + |
| 37 | +3. **Start the development server**: |
| 38 | + ```sh |
| 39 | + pnpm dev |
| 40 | + ``` |
| 41 | + The site will be available at `http://localhost:4321`. |
| 42 | + |
| 43 | +## 📁 Project Structure |
| 44 | + |
| 45 | +```text |
| 46 | +/ |
| 47 | +├── public/ # Static assets (fonts, images, icons) |
| 48 | +├── src/ |
| 49 | +│ ├── assets/ # Project-specific assets |
| 50 | +│ ├── components/ # Reusable UI components (Astro & React) |
| 51 | +│ ├── hooks/ # Custom React hooks |
| 52 | +│ ├── layouts/ # Base layouts for pages |
| 53 | +│ ├── lib/ # Utility functions and configurations |
| 54 | +│ ├── pages/ # Astro page routes (multi-language support) |
| 55 | +│ └── index.css # Global styles and Tailwind directives |
| 56 | +├── astro.config.mjs # Astro configuration & integrations |
| 57 | +├── tailwind.config.ts # Tailwind CSS theme & plugin config |
| 58 | +└── tsconfig.json # TypeScript configuration |
37 | 59 | ``` |
38 | 60 |
|
39 | | -**Edit a file directly in GitHub** |
40 | | - |
41 | | -- Navigate to the desired file(s). |
42 | | -- Click the "Edit" button (pencil icon) at the top right of the file view. |
43 | | -- Make your changes and commit the changes. |
44 | | - |
45 | | -**Use GitHub Codespaces** |
46 | | - |
47 | | -- Navigate to the main page of your repository. |
48 | | -- Click on the "Code" button (green button) near the top right. |
49 | | -- Select the "Codespaces" tab. |
50 | | -- Click on "New codespace" to launch a new Codespace environment. |
51 | | -- Edit files directly within the Codespace and commit and push your changes once you're done. |
52 | | - |
53 | | -## What technologies are used for this project? |
54 | | - |
55 | | -This project is built with: |
56 | | - |
57 | | -- Vite |
58 | | -- TypeScript |
59 | | -- React |
60 | | -- shadcn-ui |
61 | | -- Tailwind CSS |
62 | | - |
63 | | -## How can I deploy this project? |
| 61 | +## 📜 Available Scripts |
64 | 62 |
|
65 | | -Simply open [Lovable](https://lovable.dev/projects/500696ef-1d19-408f-9ad6-18bfebe05908) and click on Share -> Publish. |
| 63 | +| Script | Description | |
| 64 | +| :--- | :--- | |
| 65 | +| `pnpm dev` | Starts the development server | |
| 66 | +| `pnpm build` | Builds the project for production | |
| 67 | +| `pnpm preview` | Previews the production build locally | |
| 68 | +| `pnpm check` | Runs Astro type checks | |
| 69 | +| `pnpm lint` | Lints the project files | |
66 | 70 |
|
67 | | -## Can I connect a custom domain to my Lovable project? |
| 71 | +## 🌐 Branding & Design |
68 | 72 |
|
69 | | -Yes, you can! |
| 73 | +This project follows the **JODAZ DEV** brand guidelines: |
| 74 | +- **Background**: Stone (`color-1`) |
| 75 | +- **Accents**: Blue / Navy |
| 76 | +- **Typography**: Modern, premium sans-serif fonts. |
70 | 77 |
|
71 | | -To connect a domain, navigate to Project > Settings > Domains and click Connect Domain. |
| 78 | +--- |
72 | 79 |
|
73 | | -Read more here: [Setting up a custom domain](https://docs.lovable.dev/features/custom-domain#custom-domain) |
| 80 | +Built with ❤️ by [JODAZ DEV](https://jodaz.xyz) |
0 commit comments