Skip to content

Latest commit

 

History

History
89 lines (49 loc) · 5.47 KB

README.md

File metadata and controls

89 lines (49 loc) · 5.47 KB
Raw

CoBuild: The Ultimate Developer Job Board!

CoBuild is a web application for developers that serves as a robust job board. Its primary goal is to revolutionize the job application process by introducing an innovative approach to candidate assessment!

CoBuild achieves this by integrating coding assessment questions and job posting descriptions, empowering users to tackle coding problems directly aligned with specific job opportunities. By providing this feature, candidates can accurately evaluate their skills, benchmark their performance against other applicants, and gain valuable insights to enhance their chances of achieving success. Additionally, CoBuild caters to recruiters by presenting a curated selection of qualified candidates who possess the ideal skills and qualifications to fulfill the specific requirements of their projects or products.

image

Motivation

The motivation behind CoBuild stems from the recognition of the challenges faced by job seekers in the competitive employment landscape. Traditional job boards often lack interactivity and fail to provide meaningful feedback on candidates' technical skills. CoBuild aims to bridge this gap by combining the familiarity of job postings with the rigor of coding challenges. This unique approach helps candidates better understand the requirements of potential employers and empowers them to improve their skills accordingly.

Installation

Once you have the prerequisites in place, follow these steps to build and run the project:

  1. Clone the CoBuild repository from GitHub:
    Replace username with the actual GitHub username or organization name.

     git clone https://github.com/username/CoBuild.git

  2. Navigate to the project directory in your terminal:

     cd CoBuild

  3. Install the necessary dependencies by running the following command:

     npm install

  4. Configure the MongoDB connection settings in the .env file. Create the file if it doesn't exist, and set the appropriate values. For example:

     MONGODB_URI=mongodb://localhost:27017/cobuild

  5. Start the application by executing the following command:

     npm start

  6. Access the CoBuild web application by opening your browser and visiting

     http://localhost:3000

Contribution

We welcome contributions to CoBuild and appreciate your interest in improving the application. Here are some guidelines for contributing:

Git Flow: CoBuild follows the Feature Branch workflow. When contributing, create a new branch for your feature or bug fix.

Branch Naming:

Please use descriptive and meaningful names for your branches, summarizing the purpose of your changes.

  1. Main Branch: This branch typically holds the stable and production-ready code. It is often named "main" or "master" branch, depending on the version control system being used.

  2. Developmental Branch: This branch serves as a staging area for ongoing development work. It may be named "development" or "dev" branch.

  3. Setup Branch: This branch is created for initial setup or configuration changes. It can be named "setup" or "configuration" branch.

  4. Feature Branches: These branches are created for developing new features. Each feature can have its own branch, ideally with a descriptive name reflecting the feature being worked on. For example, a feature branch for adding user authentication could be named "feature/authentication".

  5. Bug Fix Branches: Similar to feature branches, bug fix branches are created to address specific issues or bugs. These branches can be named with a prefix like "bugfix/" followed by a descriptive name or reference to the bug being fixed. For instance, a bug fix branch for resolving a login issue could be named "bugfix/login-issue".

Issue Tracking:

We use GitHub Issues to track bugs, feature requests, and other tasks. Please check the existing issues or create a new one before starting your work.

Pull Requests:

Once you have completed your changes, submit a pull request against the main branch. Another member on the team will review the changes and provide feedback before merging.

We believe that collaboration is crucial for creating the best possible product, and we look forward to your contributions to make CoBuild even better.

Technologies Used

CoBuild utilizes a range of technologies to deliver a seamless and engaging user experience:

  • JavaScript: The primary programming language for both frontend and backend development.
  • HTML: Used for creating the structure and content of web pages.
  • CSS: Used for styling and layout of the application.
  • MongoDB: A NoSQL database used to store user profiles, job postings, and assessment data.
  • Node.js: A JavaScript runtime environment that enables server-side execution.
  • Express.js: A web application framework for Node.js, used to build the backend API.
  • Postman: A popular API development and testing tool used to ensure the smooth functioning of the API endpoints.

We believe that this combination of technologies provides a robust and efficient foundation for CoBuild, ensuring a seamless user experience and reliable performance.

Thank you for your interest in CoBuild, and we hope that our application empowers you on your job search journey!

Figma:

    https://www.figma.com/file/nWgzvMeogFUnPn5Y2Gvg7A/CoBuild?type=design&node-id=1647%3A17907&t=ay7ZFd2ppIkiJYms-1