Skip to content

Commit

Permalink
Merge pull request #968 from NitkarshChourasia/master
Browse files Browse the repository at this point in the history 
update, fix: Improving and fixing the README.md
  • Loading branch information
@NitkarshChourasia
NitkarshChourasia authored Oct 16, 2023
2 parents 123623a + e743abd commit ed3bd82
Showing 1 changed file with 73 additions and 59 deletions.
132 changes: 73 additions & 59 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# <p align="center">Welcome to the JavaScript Mini Projects</p>
# <p align="center">JavaScript Mini Projects 🚀</p>

<p align="center">
<a href="https://github.com/thinkswell/javascript-mini-projects/blob/master/LICENSE" target="blank">
<img src="https://img.shields.io/github/license/thinkswell/javascript-mini-projects?style=for-the-badge&logo=appveyor" alt="License" />
</a>
<a href="https://github.com/thinkswell/javascript-mini-projects/fork" target="blank">
<img src="https://img.shields.io/github/forks/thinkswell/javascript-mini-projects?style=for-the-badge&logo=appveyor" alt="Forks"/>
</a>
<a href="https://github.com/thinkswell/javascript-mini-projects/stargazers" target="blank">
<img src="https://img.shields.io/github/stars/thinkswell/javascript-mini-projects?style=for-the-badge&logo=appveyor" alt="Star"/>
</a>
<a href="https://github.com/thinkswell/javascript-mini-projects/issues" target="blank">
<img src="https://img.shields.io/github/issues/thinkswell/javascript-mini-projects.svg?style=for-the-badge&logo=appveyor" alt="Issue"/>
</a>
<a href="https://github.com/thinkswell/javascript-mini-projects/pulls" target="blank">
<img src="https://img.shields.io/github/issues-pr/thinkswell/javascript-mini-projects.svg?style=for-the-badge&logo=appveyor" alt="Open Pull Request"/>
</a>
</p>

## Description 🚀

Explore a diverse range of projects that showcase the capabilities of JavaScript. Whether you're just starting your coding journey or have been in the field for a while, there's something here for everyone. It's not about fancy titles; it's about the joy of coding in JavaScript. Dive in, explore the code, and let the love for coding and learning flow! Thank you for contributing to this collaborative space. Happy coding! 🌟"

## IMPORTANT!!! Setting up the Frontend to Showcase All the Projects
<a href="https://github.com/thinkswell/javascript-mini-projects/blob/master/LICENSE" target="_blank">
<img src="https://img.shields.io/github/license/thinkswell/javascript-mini-projects?style=for-the-badge&logo=appveyor" alt="License" />
</a>
<a href="https://github.com/thinkswell/javascript-mini-projects/fork" target="_blank">
<img src="https://img.shields.io/github/forks/thinkswell/javascript-mini-projects?style=for-the-badge&logo=appveyor" alt="Forks" />
</a>
<a href="https://github.com/thinkswell/javascript-mini-projects/stargazers" target="blank">
<img src="https://img.shields.io/github/stars/thinkswell/javascript-mini-projects?style=for-the-badge&logo=appveyor" alt="Stars" />
</a>
<a href="https://github.com/thinkswell/javascript-mini-projects/issues" target="blank">
<img src="https://img.shields.io/github/issues/thinkswell/javascript-mini-projects.svg?style=for-the-badge&logo=appveyor" alt="Issues" />
</a>
<a href="https://github.com/thinkswell/javascript-mini-projects/pulls" target="blank">
<img src="https://img.shields.io/github/issues-pr/thinkswell/javascript-mini-projects.svg?style=for-the-badge&logo=appveyor" alt="Open Pull Requests" />
</a>
</p>

<p align="center">Explore a diverse range of projects that showcase the capabilities of JavaScript. Whether you're just starting your coding journey or have been in the field for a while, there's something here for everyone. It's not about fancy titles; it's about the joy of coding in JavaScript. Dive in, explore the code, and let the love for coding and learning flow! Thank you for contributing to this collaborative space. Happy coding! 🌟</p>

## 🚀 Getting Started with the Frontend

**IMPORTANT! Setting up the Frontend to Showcase All the Projects**

Dear contributors,

Expand Down Expand Up @@ -56,109 +56,123 @@ We have established the "1Application-frontend" directory at the top of the repo
npm run dev
```

<h3 align="left">Languages and Tools:</h3>
<p align="left"> <a href="https://www.cprogramming.com/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/c/c-original.svg" alt="c" width="40" height="40"/> </a> <a href="https://www.w3schools.com/cpp/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/cplusplus/cplusplus-original.svg" alt="cplusplus" width="40" height="40"/> </a> <a href="https://www.w3schools.com/css/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/css3/css3-original-wordmark.svg" alt="css3" width="40" height="40"/> </a> <a href="https://expressjs.com" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/express/express-original-wordmark.svg" alt="express" width="40" height="40"/> </a> <a href="https://www.figma.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/figma/figma-icon.svg" alt="figma" width="40" height="40"/> </a> <a href="https://www.framer.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/framer/framer-icon.svg" alt="framer" width="40" height="40"/> </a> <a href="https://git-scm.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/git-scm/git-scm-icon.svg" alt="git" width="40" height="40"/> </a> <a href="https://www.w3.org/html/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/html5/html5-original-wordmark.svg" alt="html5" width="40" height="40"/> </a> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/javascript/javascript-original.svg" alt="javascript" width="40" height="40"/> </a> <a href="https://www.linux.org/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/linux/linux-original.svg" alt="linux" width="40" height="40"/> </a> <a href="https://www.mongodb.com/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/mongodb/mongodb-original-wordmark.svg" alt="mongodb" width="40" height="40"/> </a> <a href="https://www.mysql.com/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/mysql/mysql-original-wordmark.svg" alt="mysql" width="40" height="40"/> </a> <a href="https://nodejs.org" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/nodejs/nodejs-original-wordmark.svg" alt="nodejs" width="40" height="40"/> </a> <a href="https://reactjs.org/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/react/react-original-wordmark.svg" alt="react" width="40" height="40"/> </a> <a href="https://reactnative.dev/" target="_blank" rel="noreferrer"> <img src="https://reactnative.dev/img/header_logo.svg" alt="reactnative" width="40" height="40"/> </a> <a href="https://redux.js.org" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/redux/redux-original.svg" alt="redux" width="40" height="40"/> </a> <a href="https://sass-lang.com" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/sass/sass-original.svg" alt="sass" width="40" height="40"/> </a> <a href="https://tailwindcss.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/tailwindcss/tailwindcss-icon.svg" alt="tailwind" width="40" height="40"/> </a> <a href="https://www.typescriptlang.org/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/typescript/typescript-original.svg" alt="typescript" width="40" height="40"/> </a> </p>
## 🛠️ Languages and Tools

## How to Contribute
<p align="left">
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript" target="_blank" rel="noreferrer">
<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/javascript/javascript-original.svg" alt="javascript" width="40" height="40" />
</a>
<!-- Add more relevant icons as needed -->
</p>

Make some awesome projects, put them in your directory and create a pull request. and DONE ✅
## 🤝 How to Contribute

### Steps to Raise and get your PR Merged successfully.
Contribute to this repository by adding your awesome JavaScript projects. Here's how:

1. Fork this repository
### Steps to Raise and Get Your PR Merged Successfully

2. Clone the repository into your local system
1. Fork this repository.

2. Clone the repository into your local system:

```bash
git clone https://github.com/<username>/javascript-mini-projects.git
```

3. Create a branch `projectname-username`, e.g. - `git checkout -b ChatApp-thinkswell`
3. Create a branch `projectname-username`, e.g. - `git checkout -b ChatApp-thinkswell`:

```bash
git checkout -b ChatApp-thinkswell
```

4. Add your projects in the respective directory (if exist otherwise create one), the name of directory should be your `ProjectName/USERNAME`.
4. Add your projects in the respective directory (if it exists; otherwise, create one). The directory name should be your `ProjectName/USERNAME`.

Examples: `ChatApp/thinkswell`
Use of PascalCase is necessary for the naming of directory.

5. **Add `One project` at a time**
Use PascalCase for the naming of the directory.

5. **Add one project at a time.**

6. **Important! Make sure to add a README.md to your project directory**:

- For developers, include what framework, library, language you have used.
- Include the steps to run the project on a local machine.
- If you have used any API, mention how to get the API key and how to use it.
- If you have a live demo of your project, provide a link in the README.md file.
- For non-developers, describe the features of your project and how to use it.
- **Include a screenshot of your working project.**

6. **Add & commit**
6. **Add & commit**:

```bash
git add -A
git commit -m "Your commit message about project"
git commit -m "Your commit message about the project"
```

7. **Push changes to GitHub**,
7. **Push changes to GitHub**:

```bash
git push origin ChatApp-thinkswell
```

8. **Click** on `Create a Pull Request`.

9. Attach some **SCREENSHOTS/GIF** or **link of your working project** in the description _**❗Important❗**_.
9. Attach **SCREENSHOTS/GIFs** or a **link to your working project** in the description _**❗Important❗**_.

10. **Submit** the PR.

11. **Leave a ⭐ to the repo and `FOLLOW` me if you liked the project.**
11. **Leave a ⭐ on the repo and `FOLLOW` if you liked the project.**

---

### What You Can Contribute
## 🌟 What You Can Contribute

We welcome contributions from the community to enhance and expand our collection of mini JavaScript projects. Here are several ways you can contribute:

👉 **Add New Projects**
👉 **Add New Projects**:

Do you have a creative JavaScript project that you think would be a great addition to our collection? Submit your project!

👉 **Bug Fixes**
👉 **Bug Fixes**:

If you find any issues or bugs in existing projects, please report them by creating an issue. Better yet, submit a pull request with a fix!

👉 **Create Issues**
👉 **Create Issues**:

Have an idea for a new project? Create a new issue by clicking on the `New Issue` button and updating the pre-defined template.
Have an idea for a new project

We're happy to merge awesome portfolio to this repository!
? Create a new issue by clicking on the `New Issue` button and updating the pre-defined template.

---
We're happy to merge awesome portfolios into this repository!

## Usage
## 🚀 Usage

This repository contains a collection of mini JavaScript projects, each designed to demonstrate a specific concept or feature. Here's how you can use these projects:

👉 **Choose a project**
👉 **Choose a Project**:

Browse the repository to find a project that interests you. Each project is contained within its own folder.

👉 **Clone the repository**
👉 **Clone the Repository**:

Clone this repository to your local machine.

👉 **Navigate to the project folder**
👉 **Navigate to the Project Folder**:

Change directory to the specific project you want to explore.
Change the directory to the specific project you want to explore.

👉 **Open index.html or index.js in your browser**
👉 **Open index.html or index.js in Your Browser**:

Most projects include an index.html or index.js file. Open this file in your web browser to interact with the project.

👉 **Explore and interact**
👉 **Explore and Interact**:

Have fun with the project!

---

## Disclaimer
## ⚠️ Disclaimer

We are deeply committed to fostering genuine open-source contributions. Consequently, we maintain a strict policy against the use of plagiarized source code. Any Pull Requests (PRs) that do not adhere to our Terms and Conditions will be identified as spam and subsequently closed by our maintainers.

Please be aware that we do not accept responsibility for any potential damages resulting from the scripts or programs included in this repository. These projects are publicly curated and do not undergo stringent malware or virus checks. Therefore, neither the maintainers nor the owner of this repository can be held accountable for any issues arising from running any of the programs or applications found within this repository.

## <p align="center">Hurray! Now you are a part of the open source community 🚀🚀🚀</p>
##### <p align="center">Hurray! Now you are a part of the open-source community 🚀🚀🚀</p>

---

0 comments on commit ed3bd82

Please sign in to comment.