Create a page that can be embedded on a website that lists project contributors.
node scripts/bin/create protocol.ai --org all --duration 180 --spacing 10 --background "black" --title "Protocol Labs Contributors"
node scripts/bin/create libp2p.io --org libp2p --rows 5 --width 124 --title "libp2p contributors"
git clone https://github.com/...
Install dependencies:
Note that sharp
(image manipulation library) has additional dependencies that should just work:
Most recent Linux-based operating systems with glibc running on x64 and ARMv6+ CPUs should "just work"
If you're having a bad time then check the installation requirements here.
node scripts/bin/create my-project-name --title "My project Name" --org all --size 240
N.B. node scripts/bin/create --help
for usage instructions
Using the existing config, this will fetch an updated list of contributors from the API, update the avatars for each contributor, and apply any config changes passed.
node scripts/bin/update my-project-name
# You can also pass the same args to the update script as you can to the create
# script, but configuration is saved on create so you don't have to \o/
N.B. node scripts/bin/update --help
for usage instructions
node scripts/bin/delete my-project-name
N.B. node scripts/bin/delete --help
for usage instructions
Add a DEBUG environment variable to see some logs.
DEBUG=contribs:* node scripts/bin/update my-project-name
<!doctype html>
<html>
<head>
<style>
body {
margin: 0;
background: red;
}
iframe {
border: 0;
width: 100%;
height: 312px;
}
@media (min-width: 570px) {
iframe {
height: 606px;
}
}
</style>
</head>
<body>
<iframe src="http://localhost:1313/projects/protocol.ai/"></iframe>
</body>
</html>
To deploy the site, run:
# Build out the optimised site to ./public, where you can check it locally.
make
# Add the site to your local ipfs, you can check it via /ipfs/<hash>
make deploy
The following commands are available:
Build the optimised site to the ./public
dir
Preview the production ready site at http://localhost:1313 (requires hugo
on your PATH
)
Start a hot-reloading dev server on http://localhost:1313 (requires hugo
on your PATH
)
Optimise all the things!
Build the site in the public
dir and add to ipfs
(requires hugo
& ipfs
on your PATH
)