An open API service indexing awesome lists of open source software.

https://github.com/sabbir-hosen-dev/knowledge-cafee

knowledge-cafee
https://github.com/sabbir-hosen-dev/knowledge-cafee

fakedata-api localstorage react reacttailwind useeffect usestate

Last synced: 24 days ago
JSON representation

knowledge-cafee

Awesome Lists containing this project

README

          

# Knowledge Cafe

A modern web application designed with React, Vite, and Tailwind CSS. The Knowledge Cafe project is built to offer a seamless user experience with efficient performance and scalability.

## Project Setup

### Installation

1. Clone the repository:
```bash
git clone
cd knowledge-cafe
```
2. Install dependencies:
```bash
npm install
```

### Scripts

- **Development Server:**
```bash
npm run dev
```
Starts the development server using Vite.

- **Build for Production:**
```bash
npm run build
```
Builds the application for production.

- **Preview Production Build:**
```bash
npm run preview
```
Previews the production build.

- **Linting:**
```bash
npm run lint
```
Lints the project using ESLint.

## Dependencies

### Runtime
- **React:** `^18.3.1`
- **React DOM:** `^18.3.1`
- **React Icons:** `^5.3.0`
- **Prop Types:** `^15.8.1`

### Development
- **Vite:** `^5.4.8`
- **Tailwind CSS:** `^3.4.14`
- **PostCSS:** `^8.4.47`
- **AutoPrefixer:** `^10.4.20`
- **ESLint:** `^9.11.1` with React plugins
- **@vitejs/plugin-react:** `^4.3.2`
- **Type Definitions for React and React DOM**

## Features

- **Fast Development:** Leveraging Vite for blazing-fast build and development.
- **Styling:** Fully responsive design powered by Tailwind CSS.
- **Icons:** Comprehensive set of icons from React Icons.
- **Linting:** Ensures clean and maintainable code with ESLint.

## Folder Structure

```
knowledge-cafe/
├── src/
│ ├── components/ # React components
│ ├── pages/ # Application pages
│ ├── assets/ # Static assets
│ └── App.jsx # Main application file
├── public/ # Public assets
├── package.json # Project configuration
└── vite.config.js # Vite configuration
```

## Contribution

1. Fork the repository.
2. Create a new feature branch:
```bash
git checkout -b feature-name
```
3. Commit your changes:
```bash
git commit -m "Add your message"
```
4. Push to the branch:
```bash
git push origin feature-name
```
5. Open a pull request.

## License

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

## Contact

For any inquiries or contributions, feel free to reach out:
- **Email:** tssabbirhosen@gmail.com
- **Portfolio:** [Sabbir Hosen](https://sabbirhosen.netlify.app/)