brijmcq / fireship.io

Content Designed for Developer Happiness https://fireship.io

Fireship.io

Content designed to increase developer happiness 😁 and productivity 🚀.

Project Tour

The monorepo is organized into five sub-projects.

1. hugo - Static Site Generator. This is where the content lives.
2. design - Theme & CSS
3. components - Angular Elements Web Components
4. functions - Firebase Cloud Functions Serverless Backend
5. cypress - End-to-End & Integration Specs

Running the Site

First, install Hugo.

git clone <fireship-repo>

npm install

npm run dev

Visit localhost:1313 and you should be live. You do not need the web components for general content development, but they can be built with:

cd components && npm install
npm run build

Contributing

Edit and fix the site's content in hugo/content/. Feel free to submit PRs for small issues. For large issues or features open an issue first.

First, fork this repo on Github.

git clone <your-forked-repo>
npm install
npm run dev

git checkout -b my-fix
# fix some code...

git commit -m "fix: corrected a typo"
git push origin my-fix

Lastly, open a pull request on Github. Once merged, your changes will automatically be deployed to the live site via the CI/CD pipeline.

Contribute a Post

Read the style guide for some tips before contributing.

cd hugo
hugo new -k bundle lessons/angularfire-google-oauth
hugo new snippets/my-cool-snippet.md

Add Your Bio

First time? Add your bio and a social links to content/contributors.

Theme Development

The CSS and JS required in critical path is located in design.

Web Component Development

Interactive features are built with Angular Elements web components in components/