/fwgo-peworld

Peworld is an innovative job search website designed to connect leading companies in the technology industry with job seekers.

Primary LanguageJavaScriptMIT LicenseMIT

Peworld - Hire Job App



View Demo

Table of Contents

Project Description

Peworld is an innovative job search website designed to connect leading companies in the technology industry with job seekers. Our platform allows companies to easily find and recruit the best talent in the technology field. Whether you are a company looking for skilled professionals or a job seeker aiming for your dream job, Peworld provides a seamless and efficient experience for both parties. Join Peworld today and take the next step in your career or hiring journey!

Technologies Used

This website is built with following technologies:

  • ReactJS
  • Redux
  • Tailwind CSS
  • Storybook
  • Netlify

Explore the platform by visiting Peworld and experience its full range of features.

Project Structure

└── fwgo-peworld
        ├── .storybook                  # Contains configuration files for Storybook.
        │   └── main.js
        |   └── preview.js
        ├── public                      # Contains the public assets.
        │   └── vite.svg
        ├── screenshots                 # Contains screenshots of the application.
        ├── src                         # Contains the source code of the application.
        │   ├── assets                  # Contains images, icons, and other static assets.
        │   ├── components              # Contains reusable React components.
        │   ├── config                  # Contains configuration files.
        │   ├── pages                   # Contains React components that represent different pages of the application.
        │   ├── redux                   # Contains Redux actions, reducers, and the store configuration.
        │   ├── services                # Contains services for making API calls and other external interactions.
        │   ├── stories                 # Contains Storybook stories for UI components.
        │   ├── auth.js                 # Handles authentication logic.
        │   ├── hooks.js                # Contains custom React hooks.
        │   ├── index.css               # The main CSS file.
        │   ├── main.js                 # The entry point of the application.
        │   ├── utils.js                # Contains utility functions.
        ├── .env                        # Contains environment variables.
        ├── .eslintrc.cjs               # Configuration file for ESLint.
        ├── .gitignore                  # Specifies files and directories that should be ignored by Git.
        ├── index.html                  # The main HTML file.
        ├── package-lock.json           # Describes the exact tree generated, so other installations can generate identical trees.
        ├── package.json                # Contains project dependencies and scripts.
        ├── postcss.config.js           # Configuration file for PostCSS.
        ├── README.md                   # The project documentation file.
        ├── tailwind.config.js          # Configuration file for Tailwind CSS.
        └── vite.config.js              # Configuration file for Vite.

This structure helps in keeping the project organized and maintainable, making it easier to navigate and manage the codebase.

Project Repository

This project consists of both frontend and backend repositories. You can find link of backend repositoy and the deployed version of this website below:

Visit the backend repository for server-side code and API details. The live demo link will take you to the deployed version of the Peworld application.

Project Screenshots

Here are some screenshots of Peworld showcasing various pages of the application:

Register Worker Register Recruiter
Login Worker Login Recruiter
Landing Page Home Page (Search Feature)
Home Page (Sort and Filter Feature) Worker's Portfolio Page
Worker's Experiences Page Your Portfolios Page (As Worker)
Your Experiences Page (As Worker) Edit Your Profile Page (As Worker)
Notifications Page Your Profile Page (As Recruiter)
Edit Your Profile Page (As Recruiter) Hire Page

Getting Started

To get a local copy up and running, follow these simple steps.

Installation

  1. Clone the repository
git clone https://github.com/wafash08/fwgo-peworld.git
  1. Navigate to the project directory:
cd fwgo-peworld
  1. Install the dependencies:
npm install
  1. Create a .env file:

Create a .env file in the root directory of the project and add the necessary environment variables. Example of environment variable name:

VITE_API_URL_V1=yourapiurlhere
  1. Start the development server:
npm run dev

This will start the development server and open the application in your default web browser. If it doesn't, you can access it at http://localhost:3000.

Storybook

To start Storybook and view your UI components in isolation:

npm run storybook

This will start Storybook and open it in your default web browser. If it doesn't, you can access it at http://localhost:6006.

Test User Accounts

Access pre-configured user accounts for testing purposes. Use these accounts to simulate different scenarios and ensure your job offers are working as expected.

  • Recruiter Account
{
  "email": "albertdera@gmail.com",
  "password": "asdf1234"
}
  • Worker Account
{
  "email": "charliegreen@gmail.com",
  "password": "asdf1234"
}

Contributions

Any contribution to Peworld is welcomed! If you have an idea for a new feature or have found a bug, please follow these steps to contribute:

How to Contribute

  1. Fork the Repository:

Fork the repository to your own GitHub account by clicking the "Fork" button at the top right of the repository page.

  1. Clone the Forked Repository:
git clone https://github.com/your-username/fwgo-peworld.git
  1. Create a New Branch:

Create a new branch for your feature or bug fix:

git checkout -b feature/YourFeatureName

or

git checkout -b bugfix/YourBugFixName
  1. Make Your Changes:

Make the necessary changes in your local development environment.

  1. Commit Your Changes:

Commit your changes with a descriptive commit message:

git add .
git commit -m "Add Your Descriptive Commit Message"
  1. Push to Your Fork:

Push your changes to your forked repository:

git push origin feature/YourFeatureName

or

git push origin bugfix/YourBugFixName
  1. Open a Pull Request:

Open a pull request to the main repository by navigating to the original repository and clicking the "New Pull Request" button. Ensure your pull request includes a clear description of the changes and why they are necessary.

Issues

If you encounter any issues, please open an issue in the GitHub repository. Provide as much detail as possible to help us resolve the problem quickly.

License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.

Contact

If you have any questions, suggestions, or just want to get in touch, feel free to contact Me!