Docs : documentation could be improved

[jayk-gupta]

We can make it much better

[thepushkaraj]

Do you have any idea of how can we improve the documentation?

[jayk-gupta]

1. Format the code properly.
2. Make the steps clearly to run locally
3. Add contributing guidelines
   Like this:

---

The Code Nexus

The Code Nexus is a curated list of beginner-friendly open source projects that are suitable for people who are new to open source development. The goal of this project is to provide an easy way for beginners to find open source projects that are welcoming and supportive of new contributors.

⚠️ Warning: This repository is currently under development ⚠️

Please note that this repository is not yet ready.It is still being actively developed and may contain bugs, incomplete features, or other issues.

Introduction

Looking for an opportunity to contribute to open source projects but don't know where to start?
Our open source project is here to help!
"Discover beginner-friendly open source projects with our project! Our curated list makes it easy to find the perfect project to contribute to. Start your open source journey today!"

How to use this list

The projects on this list are categorized by programming language and technology.

To find a project that interests you, simply browse the list and click on the link to the project's GitHub repository. Once you've found a project you'd like to contribute to, follow the instructions in the repository's README file to get started.

Getting Started

To clone the repository to your local machine, follow these steps:

1. Go to the main page of the repository on Github.
2. Click on the "Code" button and copy the URL provided.
3. Open the terminal or command prompt on your computer.
4. Navigate to the directory where you want to clone the repository.
5. Type the command git clone [https://github.com/jayk-gupta/Code-Nexus] (This will download the repository to your local machine)

Running the Project Locally

1. Open a terminal or command prompt on your computer.
2. Navigate to the directory where the repository was cloned.
3. pnpm install (Install dependencies)
4. pnpm dev (This will launch the project in your local browser or terminal)

Adding new Project to the list

If you know of a project that would be a good fit for this list, please feel free to submit a pull request.

All contributions are welcome, and we're especially interested in projects that are actively looking for new contributors.
Here are the general steps to add a new project to your open-source project:

1. Navigate to the database folder in the src directory of your project.
2. Locate the data.json file and open it in a text editor.
3. Find the projects array in the data.json file.
4. Add a new object to the projects array in the following format:

   {
    "link": "Your project live link",
    "title": "Project Title",
    "img": "Insert Project Image url",
    "description": "Provide description of your project",
    "ghLink": "Your Project repository link"
  }

Contributing

We welcome contributions from the community!
If you're interested in contributing to this project, please read our contribution guidelines for more information on how to get started.

License

MIT License

[thepushkaraj]

@jayk-gupta

Looks great, do you want to work on this?

[jayk-gupta]

Yes!

[thepushkaraj]

@jayk-gupta

Go ahead, best of luck to you!