Peworld - Hire Job App

View Demo Front End | View Demo Back End

Table of Contents

• About
• Technologies Used
• Project Structure
• Project Repository
• Postman Documentation
• Features
• Getting Started
• Contributions
• Contact
• Related Projects

About

The backend of Peworld is designed to support the functionality of the Peworld. It provides secure and efficient APIs for user authentication, worker list, as well as worker and recruiter profiles. Built with scalability and performance in mind, the backend ensures smooth interactions between the frontend and the database, enabling a seamless user experience for both job seekers and employers.

These RESTful APIs are built by Muhammad Risano. Feel free to explore the code.

Make sure to explore the API by visiting the Postman documentation and experience its full range of features.

Technologies Used

The APIs are built with following technologies:

• Express JS
• PostgreSQL
• JSON Web Token (JWT)
• Cloudinary

Project Structure

└── be-peworld
    ├── assets                       # Contains static assets such as images.
    ├── node_modules                 # Contains project dependencies.
    ├── src                          # Contains the source code of the application.
    │   ├── config                   # Contains configuration files for database connections, etc.
    │   ├── controllers              # Contains controllers that handle requests and responses.
    │   ├── helpers                  # Contains helper functions and utilities.
    │   ├── middlewares              # Contains middleware functions for request processing.
    │   ├── models                   # Contains database models and schemas.
    │   ├── routes                   # Contains route definitions and API endpoints.
    │   ├── utils                    # Contains utility functions.
    ├── .gitignore                   # Specifies files and directories that should be ignored by Git.
    ├── index.js                     # The entry point of the application.
    ├── package-lock.json            # Describes the exact dependency tree generated, ensuring reproducible builds.
    ├── package.json                 # Contains project dependencies and scripts.
    ├── README.md                    # The project documentation file.
    ├── vercel.json                  # Configuration file for deployment on Vercel.
    └── yarn.lock                    # Locks the version of dependencies installed via Yarn.

Project Repository

This project consists of both frontend and backend repositories. You can find link of front end repositoy and the postman documentation below:

• Front End Repository: Peworld Front End

• Postman Documentation

Postman Documentation

You can see the list of API and its example usage by clicking the link below

Features

• Authentication and Authorization using JWT
• CRUD Profile Worker
• CRUD Profile Recruiter
• Upload Image
• Job Offering

Getting Started

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

Installation

1. Clone the repository

git clone https://github.com/muhammadrisano/fwm17-be-peword.git

2. Navigate to the project directory:

cd fwm17-be-peword

3. Install the dependencies:

npm install

5. 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:5000.

Contributions

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 this repository.

2. Clone the Forked Repository:

git clone https://github.com/your-username/fwgo-peworld.git

3. 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

4. Make Your Changes:

Make the necessary changes in your local development environment.

5. Commit Your Changes:

Commit your changes with a descriptive commit message:

git add .
git commit -m "Add Your Descriptive Commit Message"

6. Push to Your Fork:

Push your changes to your forked repository:

git push origin feature/YourFeatureName

or

git push origin bugfix/YourBugFixName

7. 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.

Contact

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

• Muhammad Risano (Creator of Back End Peworld)
  • Github: muhammadrisano
  • Linkedin: linkedin.com/in/muhammad-risano
• Wafa Saefulhaq (Creator of Front End Peworld)
  • Email: [email protected]
  • Linkedin: linkedin.com/in/m-wafa-saeful-haq
  • Twitter: @saefulhaqwafa

Related Projects

• Peworld Front End 🏢
• Mama Recipe 🧑‍🍳
• Marketplace 🛒