An open API service indexing awesome lists of open source software.

https://github.com/literat/literat

literat dot dev - personal blog
https://github.com/literat/literat

blog literat personal website

Last synced: 3 months ago
JSON representation

literat dot dev - personal blog

Awesome Lists containing this project

README

        

# literat dot dev

[![Coverage Status](https://coveralls.io/repos/github/literat/literat/badge.svg)](https://coveralls.io/github/literat/literat)
[![Netlify Status](https://api.netlify.com/api/v1/badges/ceadb496-c024-48f6-97e6-88a2ecb65874/deploy-status)](https://app.netlify.com/sites/literat/deploys)

1. Start developing.

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

```shell
cd my-hello-world-starter/
gatsby develop
```

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](https://www.gatsbyjs.com/tutorial/part-five/#introducing-graphiql)._

Open the `my-hello-world-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.

```bash
.
β”œβ”€β”€ 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 frontend 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.com/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.com/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.com/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.com/docs/ssr-apis/)
(if any). These allow customization of default Gatsby settings affecting
server-side rendering.

9. **`LICENSE`**: This Gatsby starter is licensed under the 0BSD license. This
means that you can see this file as a placeholder and replace it with your
own 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.com/). Here are some places to start:

## πŸ’« Deploy

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/literat/literat)