Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/actuallyakash/evie-gatsby

📦 A production-ready and minimal React.js theme for your projects and websites based on GatsbyJS. It is extremely lightweight, customizable, and works perfectly on modern browsers.
https://github.com/actuallyakash/evie-gatsby

gatsby gatsby-starter-blog gatsby-theme gatsbyjs graphql minimal react template theme

Last synced: about 1 month ago
JSON representation

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

Host: GitHub
URL: https://github.com/actuallyakash/evie-gatsby
Owner: actuallyakash
License: 0bsd
Created: 2019-10-24T18:53:47.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2023-01-11T20:28:58.000Z (almost 2 years ago)
Last Synced: 2024-09-29T16:21:56.769Z (about 2 months ago)
Topics: gatsby, gatsby-starter-blog, gatsby-theme, gatsbyjs, graphql, minimal, react, template, theme
Language: JavaScript
Homepage: https://www.gatsbyjs.com/plugins/evie-gatsby/
Size: 6.55 MB
Stars: 4
Watchers: 4
Forks: 1
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

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.

> ### Check out [Evie - Gatsby](https://github.com/actuallyakash/evie-gatsby), if you're looking for a **React based Gatsby Theme**.

## 🚀 Quick start

1. **Create a Evie - Gatsby site.**

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

```shell
# 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 ⏲.

1. **Start developing.**

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

```shell
cd my-evie-gatsby-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.com/tutorial/part-five/#introducing-graphiql)._

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!

## 🖼 Demo & Packages

- Demo on [Netlify](https://confident-yalow-b5bc0d.netlify.app/)
- Demo on [Gatsby Cloud](https://eviegatsby.gtsb.io/)
- [NPM package on npmjs.com](https://www.npmjs.com/package/evie-gatsby)
- [Official Plugin at Gatsby](https://www.gatsbyjs.com/plugins/evie-gatsby)

## 🧐 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](https://prettier.io/). 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](https://www.gatsbyjs.com/docs/gatsby-config/) for more detail).

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

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

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](https://www.gatsbyjs.com/). 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.com/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.com/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/actuallyakash/evie-gatsby)

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/actuallyakash/evie-gatsby)

## 📜 Credits

The theme is inspired by [Evie from undraw.co](https://evie.undraw.co/), which is created by [Katerina Limpitsouni](https://twitter.com/ninalimpi) and Code/design by [Aggelos Gesoulis](https://twitter.com/anges244). ✨

## 📃 Changelog

- v1.0.1
- Updated readme 📃

- v1.0.0
- Released final package 🎉