People's History of Tech Website README

Table of Contents

• People's History of Tech Website README
  • Table of Contents
  • Prerequisites
  • Install
  • Development
    • Commands
  • Content Management System
    • Local Development
  • Deployment
  • Contributing
  • Help
    • Bridgetown Questions/Gotchas

Prerequisites

• GCC
• Make
• Ruby
  • = 3.0.2
• Bridgetown Gem
  • gem install bridgetown -N
• Node
  • = 19.3.0
• Yarn

Install

After cloning down this repository:

cd peoples-history-of-tech
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!

To preview unpublished pages, run with the --unpublished switch.

Commands

# running locally
bin/bridgetown build
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

Content Management System

Blog posts, team members, case studies, events, and job posts are all website resources that are driven through an integration with DecapCMS.

Local Development

In order to access the admin portal while developing locally simply Open a new terminal from the projects root directory

Run the command

npx netlify-cms-proxy-server

This will start a proxy server for the admin portal at port 8081.

Then in a separate terminal window start up the bridgetown server. With both servers running, you can navigate to http://localhost:4000/admin/# to see the admin portal.

Contributing

1. Clone the fork using git clone to your local development machine.
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
6. Ask for a review in the #website channel in Slack

Help

Bridgetown Questions/Gotchas

• Why is the CMS complaining about duplicate collections? You can work around this by touching the src/admin/config.yml file while the servers are both running, then refreshing the CMS page.