Project Fugu API Showcase

The Project Fugu API Showcase is a collection of apps that make use of APIs that were conceived in the context of Project Fugu.

Data flow

1. Community members submit their apps to the showcase via this anonymous form (Project Fugu team members can edit form).
2. Form responses land in this world-readable spreadsheet. The form is moderated by members of Chrome's Project Fugu team.
3. The spreadsheet is published as a JSON file.
4. The file index.mjs consumes the JSON file and creates the output data in the data/ folder. Screenshots and app metadata are dynamically generated based on the live apps.
5. The whole repository is published to GitHub Pages.
6. The file data/index.html is embedded as an iframe on GoogleChrome/developer.chrome.com/site/en/blog/fugu-showcase/index.md.

Contributing

1. Fork the repository and clone your fork.
2. Install dependencies with npm i.
3. Run npm start to create a local build and serve it on http://localhost:8080.
4. You can trigger manual builds with npm run build. Changes are currently not watched, so you'll need to run npm run build manually when you make changes.
5. You can serve existing builds with npm run serve.

See CONTRIBUTING.md for more information.

Deploying a new release

(This can only be done by members of the Project Fugu team.)

1. Check the data in the spreadsheet for correctness. Remove any new rows that are spam or otherwise inappropriate. You can see when the site was last deployed by looking at the Action tab of the repo and checking for the last successful run of the pages build and deployment action.
2. Run npm start, which triggers all data in data/ to be re-generated and which opens a local copy of the site on http://localhost:8080.
3. If everything looks good, run npm run deploy to deploy the site to GitHub Pages.

License

Apache 2.0

Disclaimer

This is not an official Google product.