Skip to content

Commit

Permalink
edited readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kunjgit committed Sep 26, 2023
1 parent 342dab3 commit 6df859b
Show file tree
Hide file tree
Showing 131 changed files with 188 additions and 182 deletions.
16 changes: 11 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,16 @@

# Contribution Guidelines πŸ‘¨β€πŸ«πŸ—

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.
This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.

Make documentation for each module which is creative and also give some similar modules in reference. Provide pros and cons for the respective modules.

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.

You can also make your own user defined module and show the world its potential by adding it to Npm Box .

You may update any previously contributed module and make it more healthy for people .

To start contributing, follow the below guidelines.

## Step 1: Find a issue
Expand All @@ -17,9 +24,9 @@ To start contributing, follow the below guidelines.
## Step 2: Fork the Project
- Fork this Repository. This will create Local Copy of this Repository on your Github Profile. Keep a reference to the original project in upstream remote.
```
$ git clone https://github.com/<your-username>/LearnCPP
$ cd LearnCPP
$ git remote add upstream https://github.com/Lakhankumawat/LearnCPP
$ git clone https://github.com/<your-username>/npmBox
$ cd npmBox
$ git remote add upstream https://github.com/<your-username>/npmBox
```

<p align = "center"><img src="https://user-images.githubusercontent.com/78534043/193021627-316ca69d-3daf-47c5-96f0-e63e11b31d53.png" width=60%/> </p>
Expand Down Expand Up @@ -68,7 +75,6 @@ $ git push -u origin Branch_Name

## Step 7 : Pull Request
- Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.

- Voila! Your Pull Request has been submitted and will be reviewed by the moderators and merged.πŸ₯³

<br>
Expand Down
62 changes: 31 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
## Overview


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.
This repository contains/will contains various existing npm modules and user defined modules that you can tweak according to your needs ans use them in your projects. . Our noble aim is to craft the grandest repository of npm packages, complete with proper documentation.
So, What are you waiting for? πŸ€”

<!-- <p align="center"><img src="https://user-images.githubusercontent.com/78534043/192937053-a3345951-b607-4cd3-a05d-21ca9915955c.jpg" width=40%></p> -->
Expand Down Expand Up @@ -37,62 +37,62 @@ So, What are you waiting for? πŸ€”

| | Name of Package | npmjs URL | Doc. URL |
| ------- | ------------------------------------------ | ------------------------------------ | ----------------------------- |
| **---** | **A** |
| | **A** |
| | [Async](./Async) | https://www.npmjs.com/package/async | https://caolan.github.io/async/v3/ |
| | [Axios](./Axios/) | https://www.npmjs.com/package/axios | https://axios-http.com/ |
| **---** | **B** | | |
| | **B** | | |
| | [Bcrypt](./Bcrypt) | | |
| | [browserify](./Browserify) | | |
| **---** | **C** | | |
| | **C** | | |
| | [Cloudinary](./Cloudinary/) | | |
| | [Chalk](./chalk/) | | |
| **---** | **D** | | |
| | **D** | | |
| | [Debug](./debug) | | |
| **---** | **E** | | |
| | **E** | | |
| | [Express](./Express/) | | |
| | [Express/Router](./Router) | | |
| **---** | **F** | | |
| | **F** | | |
| | [File-System](./File-System/) | | |
| | [Fastify](./Fastify/) | | |
| **---** | **G** | | |
| | **G** | | |
| | [Grunt](./Grunt/) | | |
| **---** | **H** | | |
| **---** | **I** | | |
| **---** | **J** | | |
| | **H** | | |
| | **I** | | |
| | **J** | | |
| | [Jsonwebtoken](./jsonwebtoken/) | | |
| **---** | **K** | | |
| **---** | **L** | | |
| | **K** | | |
| | **L** | | |
| | [Lodash](./Lodash/) | | |
| **---** | **M** | | |
| | **M** | | |
| | [Moment](./Moment/) | https://www.npmjs.com/package/moment | https://momentjs.com |
| | [magic-string](./magic-string/) | | |
| | [Mongoose](./mongoose/) | | |
| | [Morgan](./morgan/) | | |
| **---** | **N** | | |
| | **N** | | |
| | [NodeMailer](./nodeMailer) | | |
| **---** | **O** | | |
| | **O** | | |
| | [ora](./ora) | | |
| **---** | **P** | | |
| | **P** | | |
| | [Password-Validator](./password-validator) | | |
| | [Prisma](./prisma/) | | |
| **---** | **Q** | | |
| **---** | **R** | | |
| | **Q** | | |
| | **R** | | |
| | [Router](./Router/) | | |
| | [RxJS](./RxJS/) | | |
| **---** | **S** | | |
| | **S** | | |
| | [Socket](./Socket/) | | |
| **---** | **T** | | |
| | **T** | | |
| | [TailWindCSS](./tailwindcss/) | | |
| | [Toastify](./Toastify/) | | |
| **---** | **U** | | |
| | **U** | | |
| | [Uid](./Uid/) | https://www.npmjs.com/package/uid | https://github.com/lukeed/uid |
| | [URL](./URL/) | | |
| **---** | **V** | | |
| | **V** | | |
| | [Validator](./Validator/) | | |
| **---** | **W** | | |
| **---** | **X** | | |
| **---** | **Y** | | |
| **---** | **Z** | | |
| | **W** | | |
| | **X** | | |
| | **Y** | | |
| | **Z** | | |


</div>
Expand Down Expand Up @@ -126,7 +126,7 @@ cd npmBox
**4.** Add a reference(remote) to the original repository.

```
git remote add upstream https://github.com/R-Ayush777/npmBox.git
git remote add upstream https://github.com/R-Ayush777/npmBox
```

**5.** Check the remotes for this repository.
Expand All @@ -148,10 +148,10 @@ 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.
___Note:___ Before making any modifications, be sure to install all essential packages with the `npm install <package name>` command.

***If You adding new package***

- Navigate to npm_Modules <`cd npm_Modules`> for existing npm packages and to user_Modules <`cd user_Modules`> for user defined packages
- 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.
Expand All @@ -175,7 +175,7 @@ git commit -m "<Relevant message>"
git push -u origin <your_branch_name>
```

**12.** To create a pull request, click on `**compare and pull requests**`.
**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.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
32 changes: 16 additions & 16 deletions Fastify/README.md β†’ npm_Modules/Fastify/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Fastify

## What is Fastify ?
Fastify is a web framework highly focused on providing the best developer experience with the least overhead and a powerful plugin architecture.

## Install:
To install Fastify in an existing project as a dependency install with npm:
```
npm i fastify
```

## Feature of Fastify:
* Highly performant: as far as we know, Fastify is one of the fastest web frameworks in town, depending on the code complexity we can serve up to 76+ thousand requests per second.
* Extendible: Fastify is fully extensible via its hooks, plugins and decorators.
* Schema based: even if it is not mandatory we recommend to use JSON Schema to validate your routes and serialize your outputs, internally Fastify compiles the schema in a highly performant function.
* Logging: logs are extremely important but are costly; we chose the best logger to almost remove this cost, Pino!
# Fastify

## What is Fastify ?
Fastify is a web framework highly focused on providing the best developer experience with the least overhead and a powerful plugin architecture.

## Install:
To install Fastify in an existing project as a dependency install with npm:
```
npm i fastify
```

## Feature of Fastify:
* Highly performant: as far as we know, Fastify is one of the fastest web frameworks in town, depending on the code complexity we can serve up to 76+ thousand requests per second.
* Extendible: Fastify is fully extensible via its hooks, plugins and decorators.
* Schema based: even if it is not mandatory we recommend to use JSON Schema to validate your routes and serialize your outputs, internally Fastify compiles the schema in a highly performant function.
* Logging: logs are extremely important but are costly; we chose the best logger to almost remove this cost, Pino!
* Developer friendly: the framework is built to be very expressive and help the developer in their daily use, without sacrificing performance and security.
36 changes: 18 additions & 18 deletions Fastify/fastify.js β†’ npm_Modules/Fastify/fastify.js
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
// ESM
import Fastify from 'fastify'
const fastify = Fastify({
logger: true
})
// CommonJs
const fastify = require('fastify')({
logger: true
})

fastify.get('/', async (request, reply) => {
reply.type('application/json').code(200)
return { hello: 'world' }
})

fastify.listen({ port: 3000 }, (err, address) => {
if (err) throw err
// Server is now listening on ${address}
// ESM
import Fastify from 'fastify'
const fastify = Fastify({
logger: true
})
// CommonJs
const fastify = require('fastify')({
logger: true
})

fastify.get('/', async (request, reply) => {
reply.type('application/json').code(200)
return { hello: 'world' }
})

fastify.listen({ port: 3000 }, (err, address) => {
if (err) throw err
// Server is now listening on ${address}
})
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
18 changes: 9 additions & 9 deletions Underscore/README.md β†’ npm_Modules/Underscore/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Underscore

## What is Underscore ?
Underscore.js is a utility-belt library for JavaScript that provides support for the usual functional suspects (each, map, reduce, filter, etc.) without extending any core JavaScript objects.

## Install:
To install Underscore in an existing project as a dependency install with npm:
```
npm i underscore
# Underscore

## What is Underscore ?
Underscore.js is a utility-belt library for JavaScript that provides support for the usual functional suspects (each, map, reduce, filter, etc.) without extending any core JavaScript objects.

## Install:
To install Underscore in an existing project as a dependency install with npm:
```
npm i underscore
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const _ = require("underscore");
const list = [[5, 1, 7], [3, 2, 1]];
_.invoke(list, 'sort');
const _ = require("underscore");
const list = [[5, 1, 7], [3, 2, 1]];
_.invoke(list, 'sort');
// => [[1, 5, 7], [1, 2, 3]]
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 6df859b

Please sign in to comment.