diff --git a/README.md b/README.md index 49a676e4..0d783548 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,8 @@ - [IPFS Tutorials at ProtoSchool](#ipfs-tutorials-at-protoschool) - [Documentation](#documentation) - [Contributing](#contributing) + - [Guidelines](#guidelines) + - [Steps to follow after adding a new example](#steps-to-follow-after-adding-a-new-example) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) ## About The Project @@ -60,11 +62,11 @@ Make sure you have installed all of the following prerequisites on your developm ``` 2. Install NPM packages ```sh - npm run init + yarn install ``` 3. Run all the examples ```sh - npm run test:examples + yarn run test ``` ## Structure @@ -96,6 +98,60 @@ Contributions are what make the open source community such an amazing place to b 4. Push to the Branch (`git push origin feature/amazing-feature`) 5. Open a Pull Request +### Guidelines + +- Follow the [example-template](`https://github.com/ipfs-examples/example-template`) + - This repository serves as template to create new examples to guarantee consistency between examples. It contains all the necessary files to create a new example + +- Examples must: + - Live inside the `/examples/` folder + - Have tests and should make use of `test-util-ipfs-example` library + - If possible use `playwright` as test framework + - Implement the following scripts: + - `clean`: used to clean all the unnecessary code (e.g.: files generated by bundlers and package managers) + - `build`: used to build the example + - `start`: used to start the example + - `test`: used to test the example + +- README must have (see example inside `example-template`): + - Link to `Codesandbox.com` for one-click running demonstration + - References for documentation/tutorials used to build the example + - _Optional:_ Screenshots, gifs, etc... under `img/` folder + +- Update the CI to run the tests of the new example as standalone + - Edit `github/workflows/ci.yml` + - Add the test name to `project` under `matrix` + +- Extend the `test-util-ipfs-example` library if needed to reuse code in other examples + +### Steps to follow after adding a new example + +- Update `js-ipfs` CI to run the test script of the example + - Edit the `.travis.yml`, search for the test examples section and add the following: + +```yml +- stage: test + name: examples - {TODO_EXAMPLE NAME} + script: + - npm run test:external -- -- -- https://github.com/ipfs-examples/{TODO_GIT_URL}.git +``` + +- Create a new repository based on (https://github.com/ipfs-examples/example-fork-go-template) following the name: `js-ipfs-{EXAMPLE_NAME}` with a description + +- Turn off issue/wikis/projects/discussions + +

+ Repo Details +

+ +- Disable Releases/Environments/Packages + +

+ Repo Settings +

+ +- Follow the instruction inside the README + ## Want to hack on IPFS? [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) diff --git a/examples/browser-angular/README.md b/examples/browser-angular/README.md index c0e714c1..731fdfe6 100644 --- a/examples/browser-angular/README.md +++ b/examples/browser-angular/README.md @@ -4,10 +4,10 @@

-

IPFS React App

+

IPFS Angular App

- Using js-ipfs in a `create-react-app` + Using js-ipfs with `Angular`

diff --git a/img/repo_details.png b/img/repo_details.png new file mode 100644 index 00000000..8fd1d9eb Binary files /dev/null and b/img/repo_details.png differ diff --git a/img/repo_settings.png b/img/repo_settings.png new file mode 100644 index 00000000..7d2cfad3 Binary files /dev/null and b/img/repo_settings.png differ