Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Abubokkor98 committed Feb 7, 2025
1 parent d189323 commit 2f500a7
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 14 deletions.
10 changes: 5 additions & 5 deletions .firebase/hosting.ZGlzdA.cache
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
_redirects,1733640044703,812d9c82ff05e58e930356d8882aa4e52f4c52d768831f011f529707f938b193
work.svg,1737578148925,2cf2ca64c3751717fe9ec697ad72b50b4cd5112a8fef82dc8c0ef8fd0a6d014d
index.html,1737956600480,7ae796ff1a9990acc34a31af3e665f816db4f449e4f9acf599f61280d537729d
assets/index-tokceSQU.css,1737956600483,1d28d3baeeeea914a81bfbae0abfc266b14638fcd58e30a68cd710a96a3331ed
assets/default-avatar-DVE6JZcB.png,1737956600480,fcb2010c531eb12e0670e1f7aebf51fb79845156e605db81a461d7ee220218dd
assets/error-CqimAJ7d.png,1737956600483,fd58779b38c93d50a6160c6fafa3c4da1be51d8acbdc82e97ae1c1015a24788d
assets/index-B4JWivXI.js,1737956600484,0ac6e44e7da336986ab592c9490c70d914c2b3359f482c3fdfdf683beb0acf71
index.html,1737963302237,9581ad664795827aca23aaecc5cd1acd15c269ecb311d51bb3a369be212e57b6
assets/index-CyxH_wf2.css,1737963302238,bac7fff30f0c2524f37697b84bfdf28b175b8e0d5c5a063a7ea4704c7c04a406
assets/default-avatar-DVE6JZcB.png,1737963302238,fcb2010c531eb12e0670e1f7aebf51fb79845156e605db81a461d7ee220218dd
assets/error-CqimAJ7d.png,1737963302239,fd58779b38c93d50a6160c6fafa3c4da1be51d8acbdc82e97ae1c1015a24788d
assets/index-C7f4t9Bm.js,1737963302244,30890c351c72efb9c66ca9d8985f548631a6c80820811c6bafe51a3924a217e2
71 changes: 62 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Whether you're an HR manager or a business owner, **WorkForce Pro** simplifies c
Fast and secure communication between frontend and backend for seamless data management.

9. **💼 Responsive Design**
Optimized for desktop, tablet, and mobile devices to ensure usability across all platforms.
Optimized for desktop, tablet, and mobile devices to ensure usability across all platforms.

10. **📂 File Uploads & Document Management**
Manage employee records by uploading and storing essential files directly on the platform.
Expand Down Expand Up @@ -107,15 +107,68 @@ Use the following credentials to access the admin dashboard:

---

### **👥 Contribution Guidelines**

We welcome contributions to enhance **WorkForce Pro**!
## Installation and Setup 🚀

1. Clone the repository:
```bash
git clone https://github.com/Abubokkor98/career-compass.git
```
2. Navigate to the project directory:
```bash
cd career-compass
```
3. Install dependencies:
```bash
npm install
```
4. Set up Firebase:

- Create a Firebase project at [Firebase Console](https://console.firebase.google.com/).
- Enable Authentication and configure the desired sign-in methods.
- Copy the Firebase configuration and create a `.env` file in the root directory.
- Add the following variables:
```plaintext
REACT_APP_FIREBASE_API_KEY=your-firebase-api-key
REACT_APP_FIREBASE_AUTH_DOMAIN=your-firebase-auth-domain
REACT_APP_FIREBASE_PROJECT_ID=your-firebase-project-id
REACT_APP_FIREBASE_STORAGE_BUCKET=your-firebase-storage-bucket
REACT_APP_FIREBASE_MESSAGING_SENDER_ID=your-firebase-messaging-sender-id
REACT_APP_FIREBASE_APP_ID=your-firebase-app-id
VITE_IMAGE_HOSTING_KEY=your_image_hosting_key
VITE_Payment_Gateway_PK=your_payment_gateway_public_key
VITE_API_URL=your_backend_api_url
```
5. Start the development server:

```bash
npm start
```

6. Access the application at `http://localhost:5173`.

## 📦 Dependencies
WorkForce Pro relies on the following key dependencies:

### **Frontend Libraries**
- **react, react-dom** – Core React framework.
- **react-router-dom** – Navigation and routing.
- **framer-motion** – Smooth animations.
- **swiper** – Interactive carousels.

### **State Management & Data Fetching**
- **@tanstack/react-query** – Efficient data fetching.
- **axios** – API requests handling.

### **UI Components & Utilities**
- **react-datepicker** – Date selection.
- **recharts** – Data visualization.
- **moment & date-fns** – Date manipulation.

### **Authentication & Notifications**
- **firebase** – Secure user authentication.
- **react-hot-toast** – User notifications.

1. Fork the repository.
2. Clone the repo:
```bash
git clone https://github.com/Abubokkor98/workforcepro.git
```

### **👥 Contribution Guidelines**

Expand Down

0 comments on commit 2f500a7

Please sign in to comment.