feat: faster build via npm ci (#305)

This adds package-lock.json to speed up install and the build.

License: MIT
Signed-off-by: Marcin Rataj <lidel@lidel.org>

.circleci/config.yml

@@ -15,7 +15,7 @@ jobs:
           NO_SANDBOX: true
     steps:
       - checkout
-      - run: npm install
+      - run: npm ci
       - run: npm run build
       - persist_to_workspace:
           root: .

.gitignore

@@ -20,7 +20,6 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 yarn.lock
-package-lock.json
 
 glyph*.svg
 stroke*.svg

CONTRIBUTING.md

@@ -21,8 +21,14 @@ Please ensure your pull request adheres to the following guidelines:
 
 ### 3. Submitting it through a PR
 
-- Make sure to run `npm run build:readme` or `yarn build:readme` before submitting the Pull Request.
+- Make sure to run `npm ci && npm run build:readme` before submitting the Pull Request.
 - The pull request should have a useful title and include a link to the package and why it should be included.
 - Submit products when they are useable, or at a state which has something to show which is awesome in itself. This cuts down on half-finished implementations.
 
 Thank you for your suggestions!
+
+
+
+-----
+
+**NOTE**: If you want to edit the README file directly (not the items/links) you need to modify the [`scripts/readme-template.md`](https://github.com/ipfs/awesome-ipfs/blob/master/scripts/readme-template.md) instead and run `make build` again. Thank you!

Makefile

@@ -1,6 +1,6 @@
 build:
 	npm --version
 	node --version
-	npm install
+	npm ci
 	npm run lint
 	npm run build

README.md

@@ -23,9 +23,10 @@ _This list is for projects, tools, or pretty much any things related to IPFS tha
 
 ## Contribute to this list!
 
-Everyone is welcome to submit their new awesome-ipfs item. In order to add an element to this list, you need to modify the files in `/data` and then run a simple `make build` before publishing your pull request as the Readme and the website are automatically generated. Check the [CONTRIBUTING.md guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md) to learn how to do so.
+Everyone is welcome to submit their new awesome-ipfs item, but it will be accepted only if it meets our [content policy](https://github.com/ipfs/awesome-ipfs/blob/master/POLICY.md).
+
+Readme and the website are automatically generated. In order to add an element to this list, you need to modify the files in `/data` and then run  `make build` before publishing your pull request. Read [contributing guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md) to learn how to do so.
 
-**NOTE**: If you want to edit the README file directly (not the items/links) you need to modify the [README template](https://github.com/ipfs/awesome-ipfs/blob/master/scripts/readme-template.md) instead and run `make build` again. Thank you!
 
 ## Apps
 

scripts/readme-template.md

@@ -18,9 +18,10 @@ _This list is for projects, tools, or pretty much any things related to IPFS tha
 
 ## Contribute to this list!
 
-Everyone is welcome to submit their new awesome-ipfs item. In order to add an element to this list, you need to modify the files in `/data` and then run a simple `make build` before publishing your pull request as the Readme and the website are automatically generated. Check the [CONTRIBUTING.md guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md) to learn how to do so.
+Everyone is welcome to submit their new awesome-ipfs item, but it will be accepted only if it meets our [content policy](https://github.com/ipfs/awesome-ipfs/blob/master/POLICY.md).
+
+Readme and the website are automatically generated. In order to add an element to this list, you need to modify the files in `/data` and then run  `make build` before publishing your pull request. Read [contributing guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md) to learn how to do so.
 
-**NOTE**: If you want to edit the README file directly (not the items/links) you need to modify the [README template](https://github.com/ipfs/awesome-ipfs/blob/master/scripts/readme-template.md) instead and run `make build` again. Thank you!
 
 #PLACEHOLDER_CATEGORIES#