Good First Issue

Hello, class of good first issue 👋

I'm right there with you on this exciting open-source adventure. As a beginner myself, I've encountered a few challenges, and one that can seem like a giant hurdle is making those cloned repositories run smoothly in your browser. I want to share what I've learned so far.

Understanding package.json and package-lock.json:

When you clone a repository, you might come across these two files: package.json and package-lock.json. They are important.

Package.json' contains project information like its name, version, and dependencies. Think of it as a guide for the project.
Package-lock.json' ensures that everyone working on the project uses the same dependencies, avoiding conflicts.

When both files are present:

If you see both package.json and package-lock.json in a project, it means the dependencies and their versions are fixed. You don't need to run npm install because it might update things. Instead, use npm ci for these reasons:

npm ci ensures that your project's dependencies are installed exactly as specified in the package-lock.json file, without any potential updates or changes. This guarantees that every developer and environment will have the same set of dependencies with the same versions, reducing the likelihood of compatibility issues. It installs dependencies exactly as specified in package-lock.json. No surprises, no compatibility issues.

Running JavaScript Projects:

For some projects that are mostly JavaScript files that I have cloned, you can simply right-click on index.html and open it with your default browser.

Project Peculiarities:

Each project can be unique, so when picking a project, make sure it has a supportive community or a place where you can seek help if needed. This community will guide you through how to go about working on the project. Always ask questions; it can be overwhelming trying out at your pace.

Kindly share your #hacktoberfest journey below! Let's learn and grow together. 🚀