Skip to content

Latest commit

 

History

History
224 lines (168 loc) · 9.14 KB

README.md

File metadata and controls

224 lines (168 loc) · 9.14 KB
Raw

👩‍💻 devFind - Discover and Connect with Skilled Developers!

License Forks Star Click Vote Issue Click Vote Open Pull Request

Table of Contents

About 🚀

  • devFind - Website
  • devFind is an open source project that aims to create a platform for developers to showcase their skills and connect with potential collaborators, all in a user-friendly and searchable format.
  • With devFind, developers can create their profiles in JSON format, which are then displayed on the web for others to discover.

Features 💪

  • One of the key features of devFind is its powerful search functionality.
  • Users can search for developers based on specific skills, locations or name, making it easy to find developers with expertise in a particular technology or programming language.
  • This makes devFind a valuable resource for project managers, recruiters, and anyone looking to connect with skilled developers for collaboration or employment opportunities.

How to add your profile Data 🤔

Thank you for your interest in contributing to our open-source project!

Prerequisites

  • A GitHub account
  • Git installed on your local development environment
  • Node Package Manager (npm) installed on your local development environment

How to Install Git

Git is a version control system that is used to manage the source code of your project.

To install Git, follow these steps:

  1. Download and install Git from the Official Website

  2. Open the terminal or command prompt on your local development environment

  3. Verify the installation of Git by running the following command:

    git --version

How to Install Node.js and npm

Node.js is a JavaScript runtime environment that allows you to run JavaScript code outside of a web browser. npm (Node Package Manager) is a package manager for JavaScript, essential for managing dependencies in Node.js projects. Here's how to install Node.js and npm:

  1. Download Node.js:

    • Visit the official Node.js website and download the appropriate installer for your operating system (Windows, macOS, or Linux).
    • Choose the LTS (Long Term Support) version for stable releases or the latest version for cutting-edge features.
    • Follow the installation instructions provided by the installer.

  2. Verify Node.js Installation:

    • After the installation is complete, open your terminal or command prompt.

    • To verify that Node.js has been installed successfully, type the following command and press Enter:

      node -v

    • This command should display the version of Node.js installed on your system. If it does, Node.js installation was successful.

  3. Verify npm Installation:

    • npm comes bundled with Node.js, so once Node.js is installed, npm is automatically installed as well.

    • To confirm that npm is installed, in your terminal or command prompt, type:

      npm -v

    • Press Enter. This command should display the version of npm installed on your system. If it does, npm installation was successful.

  4. Optional: Update npm (recommended):

    • It's recommended to keep npm up to date to access the latest features and bug fixes.

    • To update npm to the latest version, type the following command and press Enter:

      npm install -g npm@latest

    • This command will update npm to the latest stable version globally (-g flag).

By following these steps, you have successfully installed Node.js and npm on your system. You are now ready to start building JavaScript applications and managing dependencies with npm.

Steps to Add Your Profile Data

  1. Fork the repository: To create a copy of the repository in your GitHub account, click on the "Fork" button in the top right corner of the project repository page.

  2. Clone the forked repository: To clone the repository to your local development environment, open the terminal or command prompt and run the following command:

    git clone https://github.com/<your-github-username>/devFind.git

  3. Install dependencies: To install the necessary dependencies for the project, navigate to the project directory and run the following command:

    npm install

  4. Navigate to the public/data folder in your project directory.

  5. Create a new JSON file named your_github_username.json (replace your_github_username with your actual GitHub username). Open the file you just created.

  6. Add the following JSON object, replacing the placeholder values with your own details:

    {
  "name": "Your Name",
  "location": "Your Location",
  "bio": "Your Bio should be 20-30 words not more then that",
  "avatar": "https://github.com/<your-github-username>.png",
  "portfolio": "Your Portfolio URL or Github URL",
  "skills": ["Your Skill 1", "Your Skill 2", "..."],
  "social": {
    "GitHub": "https://github.com/<github-username>",
    "Twitter": "https://twitter.com/<twitter-username>",
    "LinkedIn": "https://www.linkedin.com/in/<linkedin-username>"
  }
}

  7. Save the your_github_username.json file.

  8. Navigate to the src folder in your project directory. Open the ProfilesList.json file.

  9. Add your JSON filename (your_github_username.json) to the array of filenames in the ProfileList.json file, like this:

    ["filename1.json", "filename2.json", "your_github_username.json"]

  10. Save the ProfileLists.json file.

  11. Create a new branch: To create a new branch for your profile, run the following command:

    git checkout -b add-profile

  12. Add your changed files: Add changed files to the stage by running the following command:

    git add .

  13. Commit your changes: To save your changes to the branch,, run the following command:

    git commit -m "add: <your-name>"

  14. Push to the branch: To push the changes to the remote repository, run the following command:

    git push origin add-profile

  15. Create a pull request: To submit your changes to the main repository, create a pull request by clicking on the "Compare & pull request" button on your forked repository page.

  16. Wait for review and merge: Wait for the project maintainers to review and merge your changes.

Once your changes are merged, your profile data will be added to the project's Profile.json file and your profile will be displayed on the project's website.

Contributing 👨‍💻

Contributions make the open source community such an amazing place to learn, inspire, and create.
Any contributions you make are truly appreciated!

Contributors 🤝

License
This project is licensed under MIT.

Support 🙏

Thank you for contributing to our open-source project! We appreciate your support 🚀
Don't forget to leave a star ⭐