https://github.com/bridgetownrb/bridgetown-cards

Share what you know. Build what you learn.
https://github.com/bridgetownrb/bridgetown-cards

bridgetown

Last synced: 3 months ago
JSON representation

Share what you know. Build what you learn.

• Host: GitHub
• URL: https://github.com/bridgetownrb/bridgetown-cards
• Owner: bridgetownrb
• Created: 2021-12-11T22:24:12.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-20T04:22:22.000Z (about 3 years ago)
• Last Synced: 2024-10-03T09:53:05.627Z (4 months ago)
• Topics: bridgetown
• Language: CSS
• Homepage: https://bridgetown.cards
• Size: 575 KB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](#prerequisites)

- [Install](#install)

- [Development](#development)

- [Commands](#commands)

- [Deployment](#deployment)

- [Contributing](#contributing)

## Prerequisites

- [GCC](https://gcc.gnu.org/install/)

- [Make](https://www.gnu.org/software/make/)

- [Ruby](https://www.ruby-lang.org/en/downloads/)

  - `>= 2.7`

- [Bridgetown Gem](https://rubygems.org/gems/bridgetown)

  - `gem install bridgetown -N`

- [Node](https://nodejs.org)

  - `>= 12`

- [Yarn](https://yarnpkg.com)

## Install

```sh

cd bridgetown-cards

bundle install && yarn install

```

> Learn more: [Bridgetown Getting Started Documentation](https://www.bridgetownrb.com/docs/).

## Development

To start your site in development mode, run `bin/bridgetown start` and navigate to [localhost:4000](https://localhost:4000/)!

### Commands

```sh

# 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](https://www.bridgetownrb.com/docs/command-line-usage)