Skip to content

ansari14/salar-react-

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Salar React App

A modern React application built with Tailwind CSS, featuring a beautiful and responsive design with component-based architecture.

πŸš€ Features

  • ⚑ Vite - Lightning fast build tool and development server
  • βš›οΈ React 18 - Latest React with hooks and modern features
  • 🎨 Tailwind CSS - Utility-first CSS framework for rapid UI development
  • πŸ“± Responsive Design - Mobile-first approach with beautiful UI components
  • πŸ”§ ESLint - Code linting and formatting
  • 🎯 TypeScript Ready - TypeScript support included
  • πŸ—οΈ Component Architecture - Modular and reusable components
  • 🎨 Custom Design System - Pre-configured color palette and components

πŸ“‹ Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (version 16.0 or higher)
  • npm (version 7.0 or higher) or yarn (version 1.22 or higher)

You can check your versions by running:

node --version
npm --version

πŸ› οΈ Installation

Follow these step-by-step instructions to set up the project:

Step 1: Clone or Download the Project

If you have the project files, navigate to the project directory:

cd salar-react-app

Step 2: Install Dependencies

Install all required dependencies using npm:

npm install

Or if you prefer yarn:

yarn install

Step 3: Start the Development Server

Run the development server:

npm run dev

Or with yarn:

yarn dev

The application will be available at http://localhost:3000

Step 4: Open in Browser

Open your web browser and navigate to http://localhost:3000 to see the application running.

πŸ“ Project Structure

salar-react-app/
β”œβ”€β”€ public/                 # Static assets
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/         # React components
β”‚   β”‚   β”œβ”€β”€ Header.jsx     # Navigation header
β”‚   β”‚   β”œβ”€β”€ Hero.jsx       # Hero section
β”‚   β”‚   β”œβ”€β”€ Features.jsx   # Features showcase
β”‚   β”‚   └── Footer.jsx     # Footer component
β”‚   β”œβ”€β”€ App.jsx            # Main App component
β”‚   β”œβ”€β”€ main.jsx           # Application entry point
β”‚   └── index.css          # Global styles and Tailwind imports
β”œβ”€β”€ index.html             # HTML template
β”œβ”€β”€ package.json           # Dependencies and scripts
β”œβ”€β”€ tailwind.config.js     # Tailwind CSS configuration
β”œβ”€β”€ postcss.config.js      # PostCSS configuration
β”œβ”€β”€ vite.config.js         # Vite configuration
β”œβ”€β”€ .eslintrc.cjs          # ESLint configuration
└── README.md              # Project documentation

🎨 Available Scripts

  • npm run dev - Start the development server
  • npm run build - Build the application for production
  • npm run preview - Preview the production build locally
  • npm run lint - Run ESLint to check for code issues

🎯 Key Components

Header Component

  • Responsive navigation with mobile menu
  • Clean and modern design
  • Smooth hover effects

Hero Component

  • Interactive counter demonstration
  • Call-to-action buttons
  • Responsive typography

Features Component

  • Grid layout showcasing app features
  • Icon-based feature cards
  • Hover effects and animations

Footer Component

  • Social media links
  • Quick navigation
  • Technology stack information

🎨 Tailwind CSS Configuration

The project includes a custom Tailwind configuration with:

  • Custom Color Palette: Primary blue color scheme
  • Custom Fonts: Inter font family
  • Component Classes: Pre-built button and card styles
  • Responsive Design: Mobile-first approach

Custom CSS Classes

The project includes custom component classes in src/index.css:

  • .btn-primary - Primary button styling
  • .btn-secondary - Secondary button styling
  • .card - Card component styling

πŸ”§ Customization

Adding New Components

  1. Create a new file in the src/components/ directory
  2. Import and use the component in App.jsx
  3. Style using Tailwind CSS classes

Modifying Colors

Edit the tailwind.config.js file to customize the color palette:

theme: {
  extend: {
    colors: {
      primary: {
        // Your custom colors
      }
    }
  }
}

Adding New Pages

  1. Create new components for your pages
  2. Add routing (consider using React Router)
  3. Update the navigation in the Header component

πŸš€ Building for Production

To create a production build:

npm run build

The built files will be in the dist/ directory. You can preview the production build locally with:

npm run preview

πŸ“± Browser Support

This application supports all modern browsers:

  • Chrome (latest)
  • Firefox (latest)
  • Safari (latest)
  • Edge (latest)

🀝 Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ†˜ Troubleshooting

Common Issues

Port already in use:

# Kill the process using port 3000
npx kill-port 3000
# Or use a different port
npm run dev -- --port 3001

Dependencies not installing:

# Clear npm cache
npm cache clean --force
# Delete node_modules and package-lock.json
rm -rf node_modules package-lock.json
# Reinstall
npm install

Build errors:

# Check for linting errors
npm run lint
# Fix auto-fixable issues
npm run lint -- --fix

πŸ“ž Support

If you encounter any issues or have questions:

  1. Check the troubleshooting section above
  2. Search existing issues in the repository
  3. Create a new issue with detailed information

πŸŽ‰ Getting Started

Once you have the application running:

  1. Explore the different components in the src/components/ directory
  2. Try modifying the Hero component's counter functionality
  3. Customize the color scheme in tailwind.config.js
  4. Add your own components and features

Happy coding! πŸš€

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published