Weekday UI

A dynamic and user-friendly dashboard utilizing the Weekday API to showcase job listings and company details. Designed for ease of use and seamless integration, this project is perfect for those looking to manage or explore job opportunities effectively.

Table of Contents

• Installation
• How to Run?
• File Structure
• Contributing
• License

Installation

To set up the Weekday UI on your local machine, follow these steps:

git clone https://github.com/Omi1804/weekdayPortal.git
cd weekdayPortal

Dependencies

Install the necessary dependencies to get your development environment running:

npm install

#or alternatively with yarn, pnpm, or bun

yarn install
pnpm install
bun install

How to Run?

Launch the development server by running:

npm run dev
# or with other package managers
yarn dev
pnpm dev
bun dev

Access the UI by navigating to http://localhost:5173/ in your web browser.

File Structure

-src/components:

1. CompanyDetails: Reusable Company Detailed Description to Apply on.
2. Header: Reusable Header component To be served as Navbar In future
3. SearchArea: All the Searching Components With Card Grid.
4. SideBar: Reusable SideBar to be Used to Fill User's Details for Further Use
5. SubComponents: Reusable Small Components like Card.tsx or Select input tag.

-src/reduxFiles:

1. jobSlice.ts: Contains all the Job fetching and Filtered Job Reducer
2. userSlice.ts: Contains all the User Related Data which can be used anywhere in the application
3. store.ts: Contains the React Redux Toolkit configurations

Contributing

We welcome contributions to the Weekday UI! Please read through our contributing guidelines to learn how you can contribute to this project. Guidelines include instructions on how to file issues, set up your development environment, and submit pull requests.

License

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

This `README.md` is fully formatted to use in your GitHub repository, providing detailed instructions, a breakdown of file structure, and information on contributing to your project.