https://github.com/kieranklaassen/kieranklaassen-com

My personal website
https://github.com/kieranklaassen/kieranklaassen-com

gatsby gatsby-site

Last synced: 1 day ago
JSON representation

My personal website

• Host: GitHub
• URL: https://github.com/kieranklaassen/kieranklaassen-com
• Owner: kieranklaassen
• Created: 2019-12-09T21:20:43.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-03T21:41:34.000Z (4 months ago)
• Last Synced: 2024-12-30T04:50:02.215Z (6 days ago)
• Topics: gatsby, gatsby-site
• Language: JavaScript
• Homepage:
• Size: 1.25 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Bridgetown Website README

Welcome to your new Bridgetown website! You can update this README file to provide additional context and setup information for yourself or other contributors.

## 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-site-folder

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/)!

Use a [theme](https://github.com/topics/bridgetown-theme) or add some [plugins](https://www.bridgetownrb.com/plugins/) to get started quickly.

### 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)

## Deployment

You can deploy Bridgetown sites on hosts like Render or Vercel as well as traditional web servers by simply building and copying the output folder to your HTML root.

> Read the [Bridgetown Deployment Documentation](https://www.bridgetownrb.com/docs/deployment) for more information.

## Contributing

If repo is on GitHub:

1. Fork it

2. Clone the fork using `git clone` to your local development machine.

3. Create your feature branch (`git checkout -b my-new-feature`)

4. Commit your changes (`git commit -am 'Add some feature'`)

5. Push to the branch (`git push origin my-new-feature`)

6. Create a new Pull Request