👋 Welcome to GitHubWars 🎮

Here, you can compare your GitHub stats with other fellow GitHub users. It can be against a random user or some person whose username is known to you.

How to contribute? 👩‍💻

1. GitPod
2. Local development

First of all, you need to fork the repository so that you can make changes in your own copy and not directly to the upstream repository. Later you can raise a pull request to merge your changes to the main branch of upstream repo.

GitPod

In the cloud-free development environment which will have all the dependencies you need. You can use Gitpod in the cloud.

Local development

This environment is fully on computer and requires each dependency (for example NodeJS) to be installed and set up, but gives you the most flexibility for customisation.

Prequisites

• Nodejs
• Git

Commands

1. Clone your forked repo on your local machine using command git clone https://github.com/{username}/githubwars.git
2. Run npm install in terminal to install all dependencies mentioned in package.json file.
3. Also create a Personal access token in a .env file to use the github api in an authorized manner. You can refer the .env.example file for it. On how to create PAT you can refer this link => https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
4. Finally run npm run start script to start the app in dev mode. Open http://localhost:3000 to view it in your browser. The page will reload when you make changes.You may also see any lint errors in the console.
5. After making your changes don't forget to run npm run lint or npm run lint-fix to fix any linting errors.

License 🛡

LinkFree is licensed under the MIT License - see the LICENSE file for details.

Contributing 🛠

• Contributions make the open source community an amazing place to learn, inspire, and create.
• Any contributions you make are truly appreciated.
• Let's continue contributing to keep the community active and growing.

Support 🙏

Don't forget to leave a star ⭐️