https://github.com/kamrul2006/histo-arts
This is a web application which allow users to browse historical artifacts, view details, and add their own entries. The system also allow users to like artifacts and keep track of their own contributions. The application provides a user-friendly interface for managing and displaying information about various historical items.
https://github.com/kamrul2006/histo-arts
firebase npm-package react tailwindcss
Last synced: 3 months ago
JSON representation
This is a web application which allow users to browse historical artifacts, view details, and add their own entries. The system also allow users to like artifacts and keep track of their own contributions. The application provides a user-friendly interface for managing and displaying information about various historical items.
- Host: GitHub
- URL: https://github.com/kamrul2006/histo-arts
- Owner: kamrul2006
- Created: 2025-01-10T11:03:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-24T06:52:28.000Z (about 1 year ago)
- Last Synced: 2025-06-24T06:06:57.436Z (about 1 year ago)
- Topics: firebase, npm-package, react, tailwindcss
- Language: JavaScript
- Homepage: https://k-histocraft.web.app
- Size: 3.56 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🏰 K-HistoCraft
A modern, user-friendly web application for exploring and contributing historical artifacts.
---------------------
**Project Overview and Purpose :**
This is a web application which allow users to browse historical artifacts, view details, and add their own entries. The system also allow users to like artifacts and keep track of their own contributions. The application provides a user-friendly interface for managing and displaying information about various historical items.
--------------
## 🌐 Live Demo
[https://k-histocraft.web.app](https://k-histocraft.web.app)
---
## 📖 Project Overview
K-HistoCraft is a web platform designed to let users:
- Browse and search for historical artifacts
- View detailed information about each item
- Contribute their own artifact entries
- Like and manage favorite artifacts
- Track their contributions via a user dashboard
Built with a clean, responsive interface, the app leverages powerful frontend technologies and Firebase for authentication and hosting.
---
## ✨ Features
- 🖼 Browse historical artifacts by category
- 📄 View detailed artifact pages
- ➕ Add new artifact entries
- ❤️ Like and manage favorite items
- 🧑💼 Personalized user dashboard
- 📱 Fully responsive on mobile, tablet, and desktop
- 🔐 Firebase authentication & secure routing
- 🎉 Interactive UI with smooth animations
---
## 📦 Tech Stack
### Frontend
- **React** ^18.3.1
- **React Router DOM** ^7.1.1
- **Axios** ^1.7.9
- **Framer Motion** ^12.8.0
- **SweetAlert2** ^11.15.3
- **Flowbite React** ^0.10.2
- **Lucide React**, **React Icons**, **Emotion**, and more
### Styling
- **Tailwind CSS** ^3.4.17
- **DaisyUI** ^4.12.22
- **PostCSS**, **Autoprefixer**
### Development Tools
- **Vite** ^6.0.5
- **ESLint** ^9.17.0
- **React Refresh**, **React Hooks Plugin**
- **TypeScript Types** support for React
---
## 🛠 Installation
1. **Clone the repository**
```bash
git clone https://github.com/kamrul2006/Histo-Arts.git
cd Histo-Arts
```
2. **Install dependencies**
```bash
npm install
```
3. **Set up environment variables**
Create a `.env` file in the root directory (see below).
4. **Run the development server**
```bash
npm run dev
```
---
## 🔧 Environment Variables
Create a `.env` file in your project root and add the following:
```env
FIREBASE_API_KEY=your_firebase_api_key
FIREBASE_AUTH_DOMAIN=your_firebase_auth_domain
FIREBASE_PROJECT_ID=your_firebase_project_id
FIREBASE_STORAGE_BUCKET=your_firebase_storage_bucket
FIREBASE_MESSAGING_SENDER_ID=your_firebase_messaging_sender_id
FIREBASE_APP_ID=your_firebase_app_id
```
> ⚠️ Do **not** commit `.env` files to public repositories. Add it to your `.gitignore`.
---
## 🚀 Usage
### Development
```bash
npm run dev
```
### Build for Production
```bash
npm run build
```
### Lint Code
```bash
npm run lint
```
### Preview Build
```bash
npm run preview
```
---
## 🧩 Contributing
1. Fork the repository
2. Create your feature branch: `git checkout -b feature/my-feature`
3. Commit your changes: `git commit -m "Add my feature"`
4. Push to the branch: `git push origin feature/my-feature`
5. Open a pull request
---
## 📄 License
This project is licensed under the [MIT License](LICENSE).
---
## 🙌 Acknowledgements
Thanks to all open-source contributors and UI component libraries that power K-HistoCraft.
---
## 💌 Contact
- Kamrul Islam Apurba.
- ✉ Email: [kamrulislamapurba@gmail.com](mailto:kamrulislamapurba@gmail.com)