How to Contribute to Bridgetown Cards

It's very simple! First, you'll want to fork this repo. Then add a new file to the src/_cards/2021/2022 folder using the following template and a YYYY-MM-DD-slug.md filename:

https://github.com/bridgetownrb/bridgetown-cards/blob/main/src/_cards/_CARD_TEMPLATE.md

Commit that to a branch in your forked repo, then submit a Pull Request to this repo with your submission. We'll take a look, and if it makes the cut, we'll publish it!

Note: it's fine to link to other article(s) you've written, gems, repos, etc., but we ask that you make sure your submission itself contains the bulk of the information needed to demonstrate your working functionality.

---

How to Install and Run Locally

Table of Contents

• Prerequisites
• Install
• Development
• Commands
• Deployment
• Contributing

Prerequisites

• GCC
• Make
• Ruby
  • >= 2.7
• Bridgetown Gem
  • gem install bridgetown -N
• Node
  • >= 12
• Yarn

Install

cd bridgetown-cards
bundle install && yarn install

Learn more: Bridgetown Getting Started Documentation.

Development

To start your site in development mode, run bin/bridgetown start and navigate to localhost:4000!

Commands

# running locally
bin/bridgetown start

# build & deploy to production
bin/bridgetown deploy

# load the site up within a Ruby console (IRB)
bin/bridgetown console

Learn more: Bridgetown CLI Documentation