https://github.com/protocol/launchpad
The curriculum for the Launchpad program
https://github.com/protocol/launchpad
Last synced: about 1 month ago
JSON representation
The curriculum for the Launchpad program
- Host: GitHub
- URL: https://github.com/protocol/launchpad
- Owner: protocol
- License: apache-2.0
- Created: 2022-01-14T20:45:06.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-12T23:55:55.000Z (about 1 year ago)
- Last Synced: 2025-02-12T05:15:56.357Z (12 months ago)
- Language: HTML
- Size: 150 MB
- Stars: 38
- Watchers: 4
- Forks: 91
- Open Issues: 79
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Launchpad
This repository contains intentionally organized and curated content for
Protocol Labs' Launchpad program. We welcome contributions, but please read the
Contributing section below.
The default branch for this repository is **main** for the curriculum published
on: https://curriculum.pl-launchpad.io/.
**!Important!** The content published on the now deprecated Gitbook at
https://protocol-labs.gitbook.io/launchpad-curriculum is configured & published
from the **gitbook** branch.
## Contributing to the Launchpad Curriculum
We highly encourage collaboration & contributions from others who are creating
content! Adding tutorials to the Tutorials page of the platform, and Dev Tools
pages are super helpful!
- See the [Style
Guide](https://github.com/protocol/launchpad/blob/main/STYLE-GUIDE.md) for
information on how to format the markdown and add content like images and
videos
- See the [directions for creating tutorials and dev tools
pages](https://github.com/protocol/launchpad/blob/main/templates/README.md)
- We would love to make a PR To help get you started! [ping the core
contributors](https://github.com/protocol/launchpad/graphs/contributors) to
this repository, or open an
[Issue](https://github.com/protocol/launchpad/issues).
## Sections
### Curriculum
- [Getting Started](content/en/curriculum/getting-started)
- [Web3](content/en/curriculum/web3)
- [The Protocol Labs Network](content/en/curriculum/pln)
- [IPFS](content/en/curriculum/ipfs)
- [Filecoin](content/en/curriculum/filecoin)
- [IPLD](content/en/curriculum/ipld)
- [LibP2p](content/en/curriculum/libp2p)
- [DevTools](content/en/curriculum/dev-tools)
### Tutorials
- [FVM](content/en/tutorials)
- [IPFS](content/en/ipfs-intro)
- [IPLD](content/en/ipld)
- [libp2p](content/en/libp2p)
- [Metamask](content/en/metamask-intro)
## Hugo
Use Hugo to statically serve & preview files on your machine
- Create a [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
of this repo or simply use `git clone git@github.com:protocol/launchpad.git`
- Open the `/launchpad` folder where you cloned it
- Install version 0.101.1 + of Hugo with `brew install hugo`
- Run `npm install` from the top level of the launchpad repository
- Run `hugo server` to start hugo & preview this on `localhost:1313`
> Note that you may have the run `npm install` on new/ others' branches you
> checkout and server before running `hugo server`
## Editing Content
Content is located in `content/en/` and the directories in there will be one of
the links along the top of the page.
Edit the landing pages in `section-name/index.html` or
`section-name/objectives.html` or `section-name.md`
Edit Sidebar content in `config/_default/menus/menus.en.toml`
### Content Maintainers
When editing content, please ask for a PR review from a content maintainer:
- Curriculum website structure, formatting, and maintenance: @chase
- Launchpad Getting Started: @momack2
- Web3 Basics: @hammertoe
- PL Network: @rschanger
- IPFS: @2color
- IPLD: @2color
- libp2p: @2color
- Filecoin: @hammertoe
- DevTools: @hammertoe
### Content Maintainer Expectations
1. Review and merge new PRs to their section of the curriculum
2. Keep curriculum content "up to date" - including linking to new content when its source of truth moves to new locations (ex, if curriculum content is moved to a new source of truth, link to the new source of truth within the curriculum (and remove the duplicated content)
3. Review their curriculum section at least 1x/quarter to check for needed updates / deprecation / etc
## Launchpad Homepage
The Launchpad homepage is now a single html file, which is also hosted by Hugo
and tracked in this repository at: `layouts/index.html`.
CSS for the homepage is mostly managed through tailwindcss, which gets installed
automatically with npm. Tailwindcss runs as a standalone application, monitoring
the source code, and generating only the css that will be needed. The command to
run the tailwindcss daemon from the root directory is:
```
npx tailwindcss -i ./static/css/tailwind-input.css -o ./static/css/tailwind-output.css --minify --watch
```