evie-gatsby

A production-ready and minimal theme for your projects and websites. It is extremely lightweight, customizable and works perfectly on modern browsers.

Usage no npm install needed!

<script type="module">
  import evieGatsby from 'https://cdn.skypack.dev/evie-gatsby';
</script>

README

Evie - Gatsby

A production-ready and minimal theme for your projects and websites. It is extemely lightweight, customizable and works perfectly on modern browsers.

πŸš€ Quick start

  1. Create a Evie - Gatsby site.

    Use the Gatsby CLI to create a new site, specifying the Evie-gatsby.

    # create a new Gatsby site using the Evie-Gatsby starter
    gatsby new my-evie-gatsby-starter https://github.com/actuallyakash/evie-gatsby
    

    After running the command, wait for a while, it does takes some time ⏲.

  2. Start developing.

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

    cd my-evie-gatsby-starter/
    gatsby develop
    
  3. 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.

    Open the my-evie-gatsby-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-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-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).

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

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

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

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

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

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

πŸ–Ό Demo & Packages

πŸ’« Deploy

Deploy to Netlify

Deploy with Vercel

πŸ“œ Credits

The theme is inspired by Evie from undraw.co, which is created by Katerina Limpitsouni and Code/design by Aggelos Gesoulis. ✨

πŸ“ƒ Changelog

  • v1.0.1

    • Updated readme πŸ“ƒ
  • v1.0.0

    • Released final package πŸŽ‰