For the Everyday Heroes Dev Team

🚀 Start here

1. Ensure your enviroment is set up by following this Gastby tutorial here.

2. Find a non assigned issue which you want to work and self assign your name.

3. Open Terminal. Change the current working directory to the location where you want the cloned directory.

4. Clone this repo.

   Use the Git CLI to clone this repo to your local machine.

   # clone the master branch/repo to your local machine and folder of choice 
   git clone https://github.com/wwcodecolorado/returnship-everydayheroes.git 

5. Pull down the node modules

   # pull down the needed npm modules to run the site
   npm install 

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

   cd your-project-folder
   gatsby develop

7. Before making any changes, create a branch in your name with issue number.

   # create your own branch to work on ex. rafna or rafna-issue21
   git branch [your-feature-branch-name]

8. Open the source code and start editing/ coding !

   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.

9. When making certain changes

   If you need to add a plug in or a another resource like a image you will need to stop running your site by going to your terminal and hitting control + c. Make sure your changes are saved and run "gatsby develop" again to see your changes in your local browser.

10. Updating your feature branch to latest master changes

    If you have your branch created for a while now, you may need to update it to what master has currently to avoid conflicts as you push/ commit your changes. You can skip this if you are just starting out.

    Follow these git commands or this summary:

    git checkout master
    git fetch -p origin
    git merge origin/master
    git checkout [your-feature-branch-name]
    git merge master
    git push origin [your-feature-branch-name]

11. Once you finish making changes, push your commit to your branch and do a pull request on master.

    (starting on your-feature-branch-name)

    # get a list of all the updated, added and deleted files.
    git status 
    
    # add changes to stage for commit ,or use git add file_path 		                     
    git add . 	
    
    # commit your code to your branch	                    
    git commit -m “commit message”
    
    # Upload all local branch commits to GitHub	and create upstream branch	 
    git push -u origin [your-feature-branch-name]
    
    # or if your upstream branch already exists you can just do
    git push                           

    Then go to Github and click the 'Create Pull Request' button and assign a reviewer.

12. After reviewing, your changes will be merged to the master branch.🎉 🎉 🎉

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

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

💫 Deploy

This is site is deployed currently here: https://everydayheroes-podcast.netlify.app/