ProjectsHut

Follow the following steps to add your projects to ProjectsHut:

Fork this repository

Click on Go to file (I'm doing from priyankarpal/projectshut)

Add following code to end of src/DB/projects.json

{
  "github_username": "YOUR_GITHUB_USERNAME",  
  "Social_media": {
    "gitHub": "YOUR_GITHUB_ACCOUNT_LINK",
    "LinkedIn": "YOUR_LINKEDIN_ACCOUNT_LINK",
    "Instagram": "YOUR_INSTAGRAM_ACCOUNT_LINK",
    "YouTube": "YOUR_YOUTUBE_ACCOUNT_LINK",
    "Twitter": "YOUR_TWITTER_ACCOUNT_LINK"
  },
  "Projects": [
    {
      "link": "PROJECT_LINK",
      "title": "PROJECT_NAME",
      "description": "PROJECT_DESCRIPTION",
      "tech": ["tech1", "tech2"]
    },
    {
      "link": "PROJECT_LINK",
      "title": "PROJECT_NAME",
      "description": "PROJECT_DESCRIPTION",
      "tech": ["tech1", "tech2"]
    }
  ]
}

Commit your changes

Fill up the description

Create Pull Request & wait for merge

OR, If you want to run it locally then follow these steps

Clone this repository

git clone https://github.com/[your-username]/ProjectsHut.git

Navigate to the project folder

cd ProjectsHut

install dependencies

pnpm i

Create a new branch using your `GitHub Username`

git checkout -b [name_of_your_new_branch]

Run the project

pnpm dev

Do Changes in Project you want.

Add your changes

git add .

Commit your changes

git commit -m "Added [your-changes]"

If you encounter this error while commits

husky - pre-commit hook exited with code 1(error)

Then run this command

pnpm format

Set upstream command

git remote add upstream https://github.com/priyankarpal/ProjectsHut.git

Push your changes

git push origin [name_of_your_branch]

Create Pull Request & wait for merge