Skip to content

Theo-ijoma/hoobank

Repository files navigation

Frontend Project

Overview

This project is a modern frontend application built with React, Vite, and Tailwind CSS. It features a clean and intuitive user interface (UI) combined with an excellent user experience (UX).

Features

  • React: A fast and flexible JavaScript library for building user interfaces.
  • Vite: A next-generation frontend tool that offers blazing-fast development and build processes.
  • Tailwind CSS: A utility-first CSS framework for rapid UI development.
  • Responsive Design: Ensures compatibility across various devices and screen sizes.
  • Nice UI/UX: Offers an aesthetically pleasing and user-friendly interface.

Installation

To set up the project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/Theo-ijoma/hoobank.git
  2. Navigate to the project directory:

    cd hoobank
  3. Install the dependencies:

    npm install
  4. Start the development server:

    npm run dev
  5. Open your browser and visit http://localhost:5173 to see the application in action.

Scripts

  • npm run dev: Start the development server.
  • npm run build: Build the project for production.
  • npm run preview: Preview the production build locally.

Folder Structure

├── src
│   ├── assets        # Static assets like images
│   ├── components    # Reusable React components
│   ├── pages         # Application pages
│   ├── styles        # Tailwind CSS and other styles
│   └── main.jsx      # Application entry point
├── public            # Public assets
├── package.json      # Project dependencies and scripts
└── tailwind.config.js # Tailwind CSS configuration

Technologies Used

  • React
  • Vite
  • Tailwind CSS

Deployment

The project is optimized for production builds using Vite. To deploy:

  1. Run npm run build to generate the production build.
  2. Host the dist folder on your preferred platform (e.g., Vercel, Netlify, Render).

Contribution

Contributions are welcome! To contribute:

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

License

This project is licensed under the MIT License.


Feel free to explore, contribute, and make the most of this project!

Live Site

Check out the live site here.