https://github.com/altech001/radaar

A Tech Startup Company
https://github.com/altech001/radaar

Last synced: 5 months ago
JSON representation

A Tech Startup Company

• Host: GitHub
• URL: https://github.com/altech001/radaar
• Owner: Altech001
• Created: 2025-01-25T11:40:25.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-16T14:02:04.000Z (over 1 year ago)
• Last Synced: 2025-04-05T20:27:11.317Z (about 1 year ago)
• Language: TypeScript
• Homepage: https://radaar-co.vercel.app
• Size: 229 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Radaar - Tech Company Website

![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)

![React](https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=black)

![TailwindCSS](https://img.shields.io/badge/TailwindCSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)

![Vite](https://img.shields.io/badge/Vite-B73BFE?style=for-the-badge&logo=vite&logoColor=FFD62E)

![Bun](https://img.shields.io/badge/Bun-000000?style=for-the-badge&logo=bun&logoColor=white)

![Node.js](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=node.js&logoColor=white)

![ESLint](https://img.shields.io/badge/ESLint-4B32C3?style=for-the-badge&logo=eslint&logoColor=white)

Welcome to the **Radaar** repository! This project is a **modern, responsive website** designed for a tech company, highlighting its services, team, projects, and more. Built with a cutting-edge tech stack, this project ensures a seamless, high-performing user experience.

## Table of Contents

1. [Features](#features)

2. [Directory Structure](#directory-structure)

3. [Prerequisites](#prerequisites)

4. [Installation](#installation)

5. [Scripts](#scripts)

6. [Contributing](#contributing)

7. [Support](#support)

8. [License](#license)

9. [Acknowledgments](#acknowledgments)

## 🚀Features

- **Responsive Design:** Mobile-first design using Tailwind CSS.

- **Reusable UI Components:** Consistent and flexible modern components.

- **TypeScript Integration:** For type safety and improved productivity.

- **Powered by Vite:** Lightning-fast development and build process.

- **Custom Hooks:** Implements reusable hooks for common functionalities.

- **Interactive Background Effects:** Dynamic and engaging particle effects.

- **Code Quality Tools:** Includes ESLint and Prettier.

## 📂Directory Structure

```

altech001-radaar/

├── README.md                          # Project documentation.

├── bun.lockb                          # Dependency lock file for Bun.

├── components.json                    # Component metadata for consistency.

├── eslint.config.js                   # ESLint configuration file.

├── index.html                         # Entry HTML file for the application.

├── package.json                       # Node.js metadata and scripts.

├── postcss.config.js                  # PostCSS configuration for CSS processing.

├── tailwind.config.ts                 # Tailwind CSS configuration file.

├── tsconfig.app.json                  # TypeScript configuration for the app.

├── tsconfig.json                      # Main TypeScript configuration.

├── tsconfig.node.json                 # TypeScript config for Node.js-specific files.

├── vite.config.ts                     # Vite configuration file.

├── public/                            # Public assets served as-is.

├── src/                               # Source code for the project.

    ├── components/                    # UI components for the application.

    ├── hooks/                         # Custom hooks.

    ├── lib/                           # Utility functions.

    ├── pages/                         # Page-level components.

    └── types/                         # TypeScript type definitions.

```

## 📋Prerequisites

- [Node.js](https://nodejs.org/) (v18 or higher)  

- [Bun](https://bun.sh/) (optional, for faster package management)  

- [Git](https://git-scm.com/)

## 💾Installation

1. **Clone the repository:**

   ```bash

   git clone https://github.com/Altech001/Radaar.git

   cd Radaar/

   ```

2. **Install dependencies:**

   Using **Bun**:

   ```bash

   bun install

   ```

   Using **npm**:

   ```bash

   npm install

   ```

3. **Start the development server:**

   Using **Bun**:

   ```bash

   bun dev

   ```

   Using **npm**:

   ```bash

   npm run dev

   ```

4. **Open the project in your browser:**

   Navigate to `http://localhost:8080`.

## 📜Scripts

- `dev`: Start the development server.

- `build`: Build the project for production.

- `preview`: Preview the production build locally.

- `lint`: Run ESLint for code linting.

## 🤝Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.

2. **Create a new branch**:

   ```bash

   git checkout -b feature/YourFeatureName

   ```

3. **Commit your changes**:

   ```bash

   git commit -m 'Add some feature'

   ```

4. **Push to the branch**:

   ```bash

   git push origin feature/YourFeatureName

   ```

5. Open a pull request.

## 🆘Support

- Found a bug? Let us know [here](https://github.com/Altech001/Radaar/issues)

## 📄License

This project is licensed under the **MIT License**. See the [LICENSE]() file for details.

## 🙏Acknowledgments

- [Vite](https://vitejs.dev/): for the blazing-fast build tool.  

- [Tailwind CSS](https://tailwindcss.com/): for the utility-first CSS framework.  

- [React](https://reactjs.org/): for the component-based architecture.  

- [TypeScript](https://www.typescriptlang.org/): for type safety.  

Made with ❤️ by **CodeWithAltech/Azuum Baker** for **Radaar**.

[Back to Top](#radaar---tech-company-website)