This repository contains/will contains various npm modules that you can tweak according to your needs ans use them in your projects. Our objective is to create the largest collection of npm packages with proper documentation. So, What are you waiting for? 🤔
| No | Name of Package |
|---|---|
| 1 | Moment |
| 2 | Uid |
| 3 | Validator |
| 4 | NodeMailer |
| 5 | Password-Validator |
| 6 | magic-string |
| 7 | Bcrypt |
| 8 | Express |
| 9 | ora |
| 10 | Express |
- Take a look at
contributing guidelinesif you're interested in helping! - Refer GitHub Flow.
Are we missing any of your favorite modules, which you think you can add to it❓ We invite you to contribute to this project and make it better. To start contributing, follow the below guidelines.
1. Fork this repository.
2. Clone your forked copy of the project.
git clone https://github.com/<your_user_name>/npmBox.git
3. Navigate to the project directory 📁 .
cd npmBox
4. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/R-Ayush777/npmBox.git
5. Check the remotes for this repository.
git remote -v
6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).
git pull upstream master
7. Create a new branch.
git checkout -b <your_branch_name>
8. Perfom your desired changes to the code base.
Note: Before making any modifications, be sure to install all essential packages with the npm install command.
If You adding new package
- Create new Folder with you package/module name
<name of package> - Add file with name of file package name
<name of package>.js. if it contains multiple file then main file should be name as above. - Adde README.md file which conatsins Add all neccessary information like functionalities, use-cases, code snippets etc. in the README.md file.
9. Track your changes:heavy_check_mark: .
git add .
10. Commit your changes .
git commit -m "Relevant message"
11. Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name>
12. To create a pull request, click on **compare and pull requests**.
13. Add appropriate title and description to your pull request explaining your changes and efforts done.
14. Click on Create Pull Request.
15. Voila ❗ You have made a PR to the npmBox 💥 . Wait for your submission to be accepted and your PR to be merged.
16. Congratulations! You've made your first contribution! 🙌
For further details, click on CONTRIBUTING.md
In order to make a hassle-free environment, I implore you all (while contributing) to follow the instructions mentioned above!
Happy Submissions 🙂
To maintain a safe and inclusive space for everyone to learn and grow, contributors are advised to follow the Code of Conduct.
Thanks goes to these wonderful people