Spoon River Anthology

This repository houses the source code and data for the Spoon River Anthology project. This site provides a graphical interface to view and analyze the anthology's 200+ characters and stories. It can be viewed live here.

For the Spoon River Anthology: Web of Interconnectivity site, see the repository or the live site.

Original source code by Jay Sella.

Original data + information created + curated by Nick Casertano, Oscar Lloyd, and Jay Sella.

---

💡 How to Contribute

For information on how to contribute to this project, see our Contribution Guidelines

---

🚀 Quick start

1. Prerequisites

   To clone this repository to your computer and successfully complete this quick start, you will need to have the following installed locally:

   • Git
   • Yarn

   Installation directions are beyond the scope of this document. Instead, search Google. Installing these two packages has been written about ad-nauseum.

2. Clone this site.

   From a terminal (or GitBash for Windows users), run the following command:

   git clone https://github.com/j-651/spoonriver.git

3. Start developing.

   Navigate into the repository's root directory and start it up.

   cd spoonriver/
   yarn install
   gatsby develop

4. 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 data. Learn more about using this tool in the Gatsby tutorial.

   Open the spoonriver directory in your code editor of choice and edit any file of your choosing. 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 this project.

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

1. /node_modules: This directory contains all of the modules of code that your project depends on (npm/yarn 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. .prettierignore (See .prettierrc below, first): This is a configuration file for Prettier which specifies whiles files/directories should not be auto-formatted.

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

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

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

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

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

10. LICENSE: Gatsby is licensed under the MIT license.

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 (See package.json above, first). This is an automatically generated file based on the exact versions of your yarn dependencies that were installed for this project. (You won’t change this file directly).

🎓 Learning Gatsby

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

• For most developers, it's recommended to start with their 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 their documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.