Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eclectic-coding/bridgetown_chucksmith.dev
https://github.com/eclectic-coding/bridgetown_chucksmith.dev
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/eclectic-coding/bridgetown_chucksmith.dev
- Owner: eclectic-coding
- License: mit
- Created: 2021-04-04T22:11:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-23T15:40:07.000Z (almost 2 years ago)
- Last Synced: 2024-12-01T12:07:27.684Z (27 days ago)
- Language: Liquid
- Homepage:
- Size: 1.23 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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.5`
- [Bridgetown Gem](https://rubygems.org/gems/bridgetown)
- `gem install bundler bridgetown -N`
- [Node](https://nodejs.org)
- `>= 10.13`
- [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 `yarn start` and navigate to [localhost:4000](https://localhost:4000/)!
Use a [theme](https://github.com/topics/bridgetown-theme), add some [plugins](https://www.bridgetownrb.com/plugins/), and/or run some [automations](https://github.com/topics/bridgetown-automation) to get started quickly.
### Commands
```sh
# running locally
yarn start
# build & deploy to production
yarn deploy
# load the site up within a Ruby console (IRB)
bundle exec bridgetown console
```
> Learn more: [Bridgetown CLI Documentation](https://www.bridgetownrb.com/docs/command-line-usage)
## Deployment
You can deploy Bridgetown sites on "Jamstack" hosts (Netlify, Vercel, Render, etc.) or virtually any tranditional web server 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