Omolara5861 / JobFlow

Job Flow is a fullstack application built with the MERN (MongoDB, Express, React, and Node.js) stack. It is designed to manage job applications, making it easier to keep track of job listings.

Job Flow

Introduction

Job Flow is a web-based application that allows users to manage their job applications. The application provides a simple and intuitive interface for users to create, view, and update job listings. Users can add important details such as the job title, company name, and application deadline. The application also includes features for scheduling interviews and tracking the status of each application.

Job Flow is built with the MERN (MongoDB, Express, React, and Node.js) stack, which makes it a robust and scalable application. The frontend is designed with React, which provides a responsive and fast user interface. The backend is built with Node.js and Express, which makes it easy to develop and maintain a scalable server-side application. MongoDB is used for data storage, which provides flexibility and scalability for handling large amounts of data.

Job Flow also includes a comprehensive API documentation, using Swagger. This allows users to easily understand how the application works and how to interact with it programmatically. With Job Flow, users can easily manage their job applications and streamline their job search process.

Table of contents

• Job Flow
  • Introduction
  • Table of contents
  • Preview
  • Installation
  • Usage
    • Running the Frontend
    • Running the Backend
  • Technologies
  • Contributing
  • License

Preview

View Project

Installation

To install and run this project, you will need to have the following software installed on your computer:

• Node.js

Once you have the required software installed, follow these steps to get started:

1. Clone the repository on your local machine using the following command:

git clone https://github.com/Omolara5861/JobFlow.git

2. Navigate to the project directory using the following command:

  cd JobFlow

3. Navigate to the frontend directory and install the necessary dependencies using the following command:

  cd client && npm i

4. Go back one directory by running the following command:

cd ..

4. Navigate to the backend directory and install the necessary dependencies using the following command:

cd server && npm i

Usage

Running the Frontend

To start the frontend, run the following command in the client directory:

npm start

This will start the frontend on http://localhost:3000/.

Running the Backend

To start the backend, navigate to the server folder and run the following command:

npm start

This will start the backend on http://localhost:4002/.

Once the application is up and running, you can use it to manage your job applications. You can create, edit, and delete job listings.

Job Flow comes with a comprehensive API documentation, using Swagger. You can access the API documentation by navigating to http://localhost:4002/api-docs in your web browser.

Technologies

This project was built with using:

• Frontend
  

• Backend
  

• Database & Documentation
  

• Project Management & Version Control:
  

Contributing

If you'd like to contribute to Job Flow, please follow these steps:

• Fork this repository to your own GitHub account.
• Clone the forked repository to your local machine.
• Create a new branch for your changes.
• Make your changes and test them thoroughly
• Commit your changes and push them to your forked repository.
• Submit a pull request to the original repository.

License

This project is licensed under the MIT license. Please see the LICENSE file for more information.

You can do whatever you want as long as you include the original copyright and license notice in any copy of the project/source.

Copyright (c) 2023 Laradev. All right reserved.