Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# OCTALOGIC WEBSITE

Welcome to the **Octalogic Website**! This guide will help you set up and run the project smoothly. 🚀

---

## Node.js Compatibility

This project requires minimum **Node.js 20.x**. Ensure you have the correct version installed before proceeding.

---

## Environment Configuration

Before running the application, you'll need to set up your environment variables:

1. **Request Environment File**: Contact your admin to obtain the `.env` file containing the necessary environment variables
2. **Place Environment File**: Once received, place the `.env` file in the root directory of the project
3. **Verify Setup**: Ensure the `.env` file is properly configured with all required variables

> **Note**: The application will not function correctly without the proper environment configuration. Make sure to obtain this file before proceeding with the installation.

## Package Manager (PNPM Recommended)

We recommend using **pnpm** for package management.

### Install Dependencies

Run the following command to install all required dependencies:

```sh
pnpm install
```

### Start the Application

Use this command to start the application:

```sh
pnpm dev
```

---

## Template Information

📋 **Complete Template Available**: This project includes a comprehensive template that contains all the necessary components, configurations, and implementation details you'll need for development. The template serves as a complete reference with examples and best practices already implemented.

---
14 changes: 7 additions & 7 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { defineConfig } from "astro/config";
import react from "@astrojs/react";
import tailwind from "@astrojs/tailwind";
import tailwindcss from "@tailwindcss/vite";
import icon from "astro-icon";

export default defineConfig({
// ...
integrations: [// ...
react(),
tailwind({
applyBaseStyles: false,
}),],
integrations: [react(), icon()],
vite: {
plugins: [tailwindcss()],
},
});
4 changes: 2 additions & 2 deletions components.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"rsc": false,
"tsx": true,
"tailwind": {
"config": "tailwind.config.js",
"css": "src/styles/globals.css",
"config": "",
"css": "src/styles/global.css",
"baseColor": "neutral",
"cssVariables": true,
"prefix": ""
Expand Down
28 changes: 15 additions & 13 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,26 @@
"preview": "astro preview",
"astro": "astro",
"lint": "eslint --fix \"src/**/*.{js,ts,jsx,tsx,astro}\"",
"prettier:format": "CI=true prettier --write \"**/*.{astro,tsx,ts,jsx,js,css,json,css,scss,md}\"",
"prettier:check": "CI=true npx prettier \"**/*.{astro,tsx,ts,jsx,js,css,json,css,scss,md}\" --check"
"prettier:format": "prettier --write \"**/*.{astro,tsx,ts,jsx,js,css,json,css,scss,md}\"",
"prettier:check": "npx prettier \"**/*.{astro,tsx,ts,jsx,js,css,json,css,scss,md}\" --check"
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/react": "^4.1.2",
"@astrojs/tailwind": "^5.1.4",
"@astrojs/react": "^4.3.0",
"@astrojs/ts-plugin": "^1.10.4",
"@radix-ui/react-avatar": "^1.1.2",
"@radix-ui/react-dropdown-menu": "^2.1.4",
"@radix-ui/react-navigation-menu": "^1.2.3",
"@radix-ui/react-select": "^2.1.4",
"@radix-ui/react-slot": "^1.1.1",
"@datocms/astro": "^0.6.2",
"@fontsource-variable/montserrat": "^5.2.6",
"@fontsource/barlow-condensed": "^5.2.6",
"@iconify-json/material-symbols": "^1.2.29",
"@shadcn/ui": "^0.0.4",
"@tailwindcss/vite": "^4.1.11",
"@types/react": "^19.0.3",
"@types/react-dom": "^19.0.2",
"astro": "^5.1.3",
"lucide-react": "^0.469.0",
"astro": "^5.10.2",
"astro-icon": "^1.1.5",
"radix-ui": "^1.4.2",
"react": "^19.0.0",
"react-datocms": "^7.2.2",
"react-dom": "^19.0.0",
"react-router-dom": "^7.1.1",
"tailwind-merge": "^2.6.0"
Expand All @@ -35,6 +36,7 @@
"@eslint/compat": "^1.2.4",
"@eslint/eslintrc": "^3.2.0",
"@eslint/js": "^9.17.0",
"@iconify/react": "^6.0.0",
"@types/node": "22.10.5",
"@types/react": "^19.0.3",
"@types/react-dom": "19.0.2",
Expand All @@ -52,14 +54,14 @@
"eslint-plugin-prefer-arrow": "^1.2.3",
"eslint-plugin-prettier": "^5.2.1",
"eslint-plugin-unicorn": "^56.0.1",
"postcss": "^8.4.49",
"prettier": "^3.4.2",
"prettier-plugin-astro": "^0.14.1",
"prettier-plugin-tailwindcss": "^0.6.9",
"pretty-quick": "^4.0.0",
"tailwind-variants": "^0.3.0",
"tailwindcss": "^3.4.17",
"tailwindcss": "^4.1.11",
"tailwindcss-animate": "^1.0.7",
"tw-animate-css": "^1.3.4",
"typescript": "5.7.2"
}
}
Loading
Loading