SESA Gatsby Site

Before You Begin

1. Follow the setup instructions found here: https://www.gatsbyjs.org/tutorial/part-zero/

2. It is recommended to use VSCode with the Prettier extension:

   VSCode

   Prettier (Or search in the Extensions tab in VSCode)

3. We Follow the Standard GitHub Workflow

   This means you should create a branch or fork and open a Pull Request before merging to master

🚀 Running Locally:

1. Clone the repo

   Clone the repo using Git.

   git clone https://github.com/sesa-uottawa/sesa-gatsby.git

2. Start developing.

   Navigate into the site’s directory and start it up.

   cd sesa-gatsby/
   gatsby develop

3. Open the source code and start editing!

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

   You can now open a branch using

   git checkout -b <branch-name>

   You just need to replace <branch-name> with a name describing what you're working on.

🧐 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
└── yarn.lock

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. LICENSE: Gatsby is licensed under the MIT license.

10. 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).

11. 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.

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

13. yarn.lock: Yarn is a package manager alternative to npm. You can use either yarn or npm, though all of the Gatsby docs reference npm. This file serves essentially the same purpose as package-lock.json, just for a different package management system.

🎓 Learn More About the Tools We Use

Gatsby

Full documentation for Gatsby lives on their 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.

React

React offers a tutorial to learn by doing

Or, if you learn concepts step-by-step you can read their guide to concepts

Git

GitHub offers many different tutorials for learning Git and Version Control

Javascript, HTML and CSS

W3schools gives simple explanations for various parts of JS, HTML and CSS

There are also many other free tutorials and courses online such as The Odin Project or Codeacademy

💫 Deployment Status

Maintained By

Everyone

See an error? Feel free to submit a pull request, open up an issue, or post on our facebook page.