Skip to content

jsanjaikumar/Brainwave

Repository files navigation

Brainwave

Brainwave is a modern React-based web application designed to showcase advanced UI/UX with Tailwind CSS, Vite, and a rich set of visual assets. The project leverages the latest frontend technologies to deliver a performant and visually appealing user experience.

Features

  • ⚡️ Vite for fast development and optimized builds
  • 🎨 Tailwind CSS for utility-first, customizable styling
  • ⚛️ React 18 for building interactive UIs
  • 🌐 React Router DOM for client-side routing
  • 🎥 Parallax Effects with react-just-parallax
  • 🔒 Scroll Lock for enhanced modal and overlay experiences
  • 📦 Modern asset pipeline with SVGs and images

Getting Started

Installation

  1. Clone the repository:

    git clone https://github.com/jsanjaikumar/Brainwave.git
    cd Brainwave AI
  2. Install dependencies:

    npm install
    # or
    yarn install
  3. Configure environment variables:

    • Copy .env.example to .env
    • Update the values as needed
  4. Run the development server:

    npm run dev
    # or
    yarn dev
  5. Open your browser and navigate to http://localhost:3000

Project Structure

Brainwave-AI/
├── public/                # Static assets
├── src/
│   ├── assets/            # Images and SVGs
│   ├── components/        # React components
│   ├── constants/         # App constants
│   ├── App.jsx            # Main App component
│   ├── index.css          # Global styles
│   └── main.jsx           # Entry point
├── [index.html](http://_vscodecontentref_/0)             # HTML template
├── [tailwind.config.js](http://_vscodecontentref_/1)     # Tailwind CSS config
├── [postcss.config.js](http://_vscodecontentref_/2)      # PostCSS config
├── [vite.config.js](http://_vscodecontentref_/3)         # Vite config
├── [package.json](http://_vscodecontentref_/4)           # Project metadata and scripts
└── [README.md](http://_vscodecontentref_/5)              # Project documentation

Contributing

We welcome contributions to Brainwave! To get started:

  1. Fork the repository
  2. Create a new branch: git checkout -b feature/YourFeature
  3. Make your changes
  4. Commit your changes: git commit -m 'Add some feature'
  5. Push to the branch: git push origin feature/YourFeature
  6. Submit a pull request

Please ensure your code adheres to the project's coding standards and includes appropriate tests.

License

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

About

brainwave is a modern, responsive frontend for an AI agent interface, designed and developed as a solo project .

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published