Skip to content

Latest commit

 

History

History
107 lines (66 loc) · 5.81 KB

README.md

File metadata and controls

107 lines (66 loc) · 5.81 KB
Raw

Gitpod Ready-to-Code

Agile Brazil Hotsite

CircleCI

Repository for Agile Brazil website at https://www.agilebrazil.com/

Important branches

  • development: branch for development of the current year;
  • legacy: branch for past conferences. Most years are being recovered using a wayback-machine downloader. More info on how to on the README on that branch;
  • master: we don't push there. :-D Some magic with Mergify will do the magic of pulling the two together when you create a PR from either of the branches above.

🚀 Quick start

  1. Start developing.

    Navigate into your new site’s directory and start it up.

    docker-compose up

    And with Make:

    cd website/
make configure
make dev-server

  2. Open the source code and start editing!

    Your site is now running at http://localhost:8000!

    Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

    Open the my-default-starter directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

Deploying

The deployment of this website relies on code and some pretty extensive configuration of Github webhooks and integrations. The specifics are unknown to this author but check the procedures below.

While following the steps below, check CircleCI (https://app.circleci.com/pipelines/github/agile-alliance-brazil/agile-brazil-hotsite) for deployment status in either environment.

To staging

Whenever you push code to the develoment branch, it triggers the CircleCI pipeline. Check it out at http://staging.agilebrazil.com/

To prod

  • After checking that staging is ok, open a pull request into master from development.
  • Then ask a fellow commiter to review your PR, and make the necessary fixes.
  • When they approve it, Mergify will automatically merge it to master.
  • A couple minutes later, it should be fine.

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── src
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md

  1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

  2. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

  3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

  4. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

  5. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

  6. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

  7. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

  8. gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.

  9. package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

  10. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

  11. README.md: A text file containing useful reference information about your project.

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

  • For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

  • To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.