LukeParke/unicorn-utterances
1
0
Fork 0
mirror of https://github.com/LukeHagar/unicorn-utterances.git synced 2025-12-10 12:57:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Edits made to intro post, added proper initial README

Browse Source
This commit is contained in:
Corbin Crutchley
2019-06-29 23:29:42 -07:00
parent 07271791de
commit fa55f33801
2 changed files with 18 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
README.md
View File

@@ -1,97 +1,23 @@
<!-- AUTO-GENERATED-CONTENT:START (STARTER) -->
<p align="center"> <p align="center">
<a href="https://www.gatsbyjs.org"> <img alt="Unicorn Utterances logo" src="./content/assets/unicorn-utterances-logo-512.png"/>
<img alt="Gatsby" src="https://www.gatsbyjs.org/monogram.svg" width="60" />
</a>
</p> </p>
<h1 align="center"> <h1 align="center">
Gatsby's blog starter Unicorn Utterances Website
</h1> </h1>
Kick off your project with this blog boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React. This repository acts as the source code location for the Unicorn Utterances blog found [here](https://unicorn-utterances.com)
_Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._ ## Important Files
## 🚀 Quick start ### Blog Posts
1. **Create a Gatsby site.** Should be located under [`content/blog/post-name-here`](./content/blog/). You should then have an `index.md` file containing a frontmatter (with JS header, not YAML) portion and any related files should be in the same folder.
Use the Gatsby CLI to create a new site, specifying the blog starter. ### Author Data File
The author data file is located at [`src/data/authors.json`](./src/data/authors.json). To add yourself as an author in a PR for a new post, you'd add your information as a new JSON object in the array, then add a profile picture to the `data` folder. The `pronouns` field should match an `id` in the `pronouns.json` (if yours is not listed, please add it as a new value in that file, we've tried to do our best to include everything we've found!)
```sh
# create a new Gatsby site using the blog starter
gatsby new my-blog-starter https://github.com/gatsbyjs/gatsby-starter-blog
```
1. **Start developing.**
Navigate into your new site’s directory and start it up. ## 🚀 Develop
```sh To start the develop server, run `npm run develop`, it will then start the local instance at `http://localhost:8000`. You also have the ability to checkout the GraphiQL tool at `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](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql).
cd my-blog-starter/
gatsby develop
```
1. **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](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._
Open the `my-blog-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!
## 🧐 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](https://prettier.io/). 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](https://www.gatsbyjs.org/docs/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](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail).
7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/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](https://www.gatsbyjs.org/docs/ssr-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](https://www.gatsbyjs.org/). Here are some places to start:
- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** 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](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
## 💫 Deploy
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-blog)
<!-- AUTO-GENERATED-CONTENT:END -->

16
content/blog/uttering-hello-introduction-post/index.md
View File

@@ -10,13 +10,13 @@
Learning itself is such an interesting thing to think about. Learning itself is such an interesting thing to think about.
I'm always driven to learn more about the world around me, I simply find the act of growing in understanding on a given topic fascinating. One of the things I've come to love learning about the most is the field I'm in: Computer Science. There are so many people with such great knowledge that I've been blessed to be mentored by, be adjacent to, or even be friends with. Because of them, I am where I am today. I have always been driven to learn more about the world around me. I find the act of simply understanding a topic fascinating. One of the things I've come to love learning about the most is Computer Science. There are so many people with exceptional knowledge that I've been blessed to be mentored by, be adjacent to, or even be friends with. Because of them, I am where I am today.
Likewise, I love being able to relay the things that others have taught me in a way that I feel to be expressive and accessible to others. As I've grown as developer and person, I've found that there seems to be a lack of resources in a number of topics that I've come across. As a result, I've spent countless hours pouring over confusing, loosely compiled, or otherwise inaccessible resources. Oftentimes, I would find myself even unable to learn despite these resources and had to rely on "playing" with the code itself or turning to others and relying on verbal affirmation of information in order to learn some topics better. Being able to take that experience and improve upon it and share it is always an exciting idea for me. Likewise, I love being able to relay the things that others have taught me in a way that I feel to be expressive and accessible to others. As I've grown as a developer and person, I've found that there seems to be a lack of resources in a number of topics that I've come across. As a result, I've spent countless hours pouring over confusing, loosely compiled, or otherwise inaccessible resources. Oftentimes, I would find myself unable to learn with resources and had to rely on "playing" with the code itself or turning to others and relying on verbal affirmation of information in order to learn some topics better. Being able to take that experience and improve upon it and share it is always an exciting idea for me.
Over time, I've found myself wanting to share that information more and more, joining bootcamps to become a TA, writing some small-scale blog posts, giving talks, it's been a blast! I love meeting new people, hearing their experience, and often learning not only from talking to them, but by having to teach (which requires me to gain a deeper understanding in the things I want to teach and share). Over time, I've found myself wanting to share that information more and more: joining bootcamps to become a TA, writing some small-scale blog posts, giving talks. It's been a blast! I love meeting new people, hearing their experience, and often learning not only from talking to them, but by having to teach (which requires me to gain a deeper understanding in the things I want to teach and share).
Today, I'm hoping to start on a new project to share even more and to grow what I hope to be a fantastic community around the project. I want to start a blog. Well, that might be what it is now, but I want it to be more in the future and leaving it like that is underselling the idea. Let's talk about the project's ultimate goals. Today, I'm starting on a new project to share even more. One of the goals of said project is to grow what I hope to be a fantastic community that is able to benefit from the things shared here and contribute to even further community engagement. I want to start a blog. Well, that might be what it is now, but I want it to be more in the future and leaving it like that is underselling the idea. Let's talk about the project's ultimate goals.
# Ultimate Goals # Ultimate Goals
@@ -32,11 +32,11 @@ This project is going to be a long-standing effort to try to write as often as p
In terms of content, there is an extremely in-depth article which is being edited as we speak. Within the next few weeks, keep your eye out for new posts on the site. If you use RSS to keep up with your favorite content, [we have that as well](https://unicorn-utterances.com/rss.xml). In terms of content, there is an extremely in-depth article which is being edited as we speak. Within the next few weeks, keep your eye out for new posts on the site. If you use RSS to keep up with your favorite content, [we have that as well](https://unicorn-utterances.com/rss.xml).
Finally, I immediately want to be accessible to people of all forms of physical capabilities. Great care has been taking to ensure this site follows proper accessibility requirements. If there is anything on the site pertaining to accessibility that does not work, please let us know, it will be treated as diligently as any other bug preventing users from accessing the site. Finally, I immediately want to be accessible to people of all forms of physical capabilities. Great care has been taken to ensure this site follows proper accessibility requirements. If there is anything on the site pertaining to accessibility that does not work, please let us know, it will be treated as diligently as any other bug preventing users from accessing the site.
# Who's Helped! # Who's Helped!
Though the site is young, we've already had some amazing folks help us along the way of creating what we have now (and what we're going to be doing in the immediate future 🤫) Though the site is young, we've already had some amazing folks help us along the way creating what we have now (and what we're going to be doing in the immediate future 🤫)
Starting with the logo, I've been absolutely blessed to have the amazing [Vukasin](https://twitter.com/vukash_in) (creator of CandyCons, PixBit, etc) create a fun and cute logo that you've almost certainly seen by now (if not, the homepage has it in decent quality. Go and take a peek - it's "aww" worthy for certain!) Starting with the logo, I've been absolutely blessed to have the amazing [Vukasin](https://twitter.com/vukash_in) (creator of CandyCons, PixBit, etc) create a fun and cute logo that you've almost certainly seen by now (if not, the homepage has it in decent quality. Go and take a peek - it's "aww" worthy for certain!)
@@ -44,10 +44,10 @@ As for the site's design, that was handled by the supremely talented and ever-la
Due to time constraints on my part, much of his designs weren't able to be realized for the launch, but needless to say we have an exciting roadmap ahead and making his designs a reality is certainly one of them. Due to time constraints on my part, much of his designs weren't able to be realized for the launch, but needless to say we have an exciting roadmap ahead and making his designs a reality is certainly one of them.
Last, but certainly not least, the site has had some incredible help with getting the site live and deployed from [Evelyn Hathaway](https://twitter.com/evelynhathaway_). She's been an amazing help both in terms of giving suggestions and feedback on all ends of the site, but getting hosting working properly, handling SSL, redirects, etc. Sincerely couldn't do it without her Last, but certainly not least, the site has had some incredible help with getting the site live and deployed from [Evelyn Hathaway](https://twitter.com/evelynhathaway_). She's been an amazing help both in terms of giving suggestions and feedback on all ends of the site as well as getting hosting working properly, handling SSL, redirects, etc. Sincerely couldn't do it without her
# What's Next # What's Next
We have some exciting stuff coming up. As mentioned before, there's going to be an in-depth post coming very soon, many posts that've been started and need editing and finalization and there's an absolutely gargantuan list of other posts I'd like to work on. We have some exciting stuff coming up. As mentioned before, there's going to be an in-depth post coming very soon. We also have many posts that've been started, but need editing and finalization before being sent out. That's not the end, though. There's an absolutely gargantuan list of other posts I'd like to work on, and it seems to be growing every day.
You can keep up-to-date either by [following me on Twitter](https://twitter.com/crutchcorn) or by utilizing [our RSS feed](https://unicorn-utterances.com/rss.xml) You can keep up-to-date either by [following me on Twitter](https://twitter.com/crutchcorn) or by utilizing [our RSS feed](https://unicorn-utterances.com/rss.xml)