priyanshuraj21030 / vit-links-backend

💥 VITLinks is the place where you can find & connect with fellow VITians! You can also browse other students, check out their social links & share the unique link for all your needs! This API returns data of all contributors with dynamic endpoints

VIT Links! 💥

VITLinks is the place where you can find & connect with fellow VITians! You can also browse other students, check out their social links & share the unique link for all your needs! Add your name to VITLinks by a simple "contribution" to our backend repository!
You can contribute to this project in a lot of ways, we will be opening issues soon but feel free to open them if you have any ideas!

VIT Links homepage - https://vit-links-frontend.vercel.app/
Your VIT Links unique profile! - https://vit-links-frontend.vercel.app/githubUsername

Note - Adding your name to VITLinks is done in our backend repository & wont be counted as a valid hacktoberfest contribution.

🏅💻 Hacktoberfest21

Hacktoberfest is back this year!

Hacktoberfest is an annual month-long celebration of open source organised every year by DIgital Ocean. Every participant who follows their set of rules and get 4 Pull Requests (PRs) merged will receive swags. Pull requests must be approved by a maintainer of the repository/project to count.
You can sign up anytime between October 1 and October 31. Just be sure to sign up on the official Hacktoberfest website for your pull requests to count.

💻Tech Stack (Frontend)

🤩 Contributors :

Every contributor's efforts and time are deeply appreciated 😄

🤔 What to contribute?

Add your details to this repo, so that everyone can find you on VITLinks! To add your details, follow the steps given below 👇

📌 How to contribute? :

1. Fork this repository.

2. Clone your forked copy of the project.

git clone https://github.com/YOUR_GITHUB_USERNAME/VIT-links-backend.git

3. Navigate to the project directory 📁 .

cd VIT-links-backend

4. Create a new branch.

git checkout -b <YOUR_GITHUB_USERNAME>

5. In public/data folder, create a new json file with the name: YOUR_GITHUB_USERNAME.json Copy and paste this example data in the newly created file -

{
    "name": "YOUR_NAME",
    "githubUsername": "YOUR_GITHUB_USERNAME",
    "profilePicture": "LINK_TO_YOUR_PFP",
    "description": "YOUR_DESCRIPTION",
    "university": "VIT",
    "branch": "YOUR_BRANCH",
    "graduationYear": 2024,
    "links": [
        {
            "name": "Follow me on GitHub",
            "url": "YOUR_GITHUB_LINK"
        },
        {
            "name": "Follow me on Instagram",
            "url": "YOUR_INSTAGRAM_LINK"
        },
        {
            "name": "Connect with me on LinkedIn",
            "url": "YOUR_LINKEDIN_LINK"
        }
    ]
}

6. Stage your changes:heavy_check_mark:

git add . 

7. Commit your changes .

git commit -m "Relevant message"

8. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

9. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.

10. Add appropriate title and description to your pull request explaining your changes and efforts done. Always make sure you have pulled the latest code from the master branch before making a PR.

11. Click on Create Pull Request.

12. Hurray ❗ You have created a PR to the GeekForGeeks VIT-B Hacktoberfest21 Website 💥 . Sit back patiently and relax till then the project maintainers will review your PR. Please understand, there will be some time taken to review a PR and can vary from a few hours to a few days too so be Patient and keep contributing.

🥳 Project Maintainer & Admin

Sajal Gupta