Code Monkey home page Code Monkey logo

gndx.dev's Introduction

๐Ÿš€ EV0 Astro Theme - Blog Template

EV0 Astro Theme is a free and open-source serverless blog template, built with Astro, Tailwind CSS, and TypeScript. It serves as a starting point for creating your personal portfolio website or showcasing your projects online. The template is open-source and released under the MIT license, meaning you are free to use, modify, and distribute it for personal or commercial purposes.

EV0 Astro Theme

๐Ÿ”ฅ DEMOS

๐Ÿ”ฅ Features

  • โœ… Minimal styling (Tailwind CSS)
  • โœ… 100/100 Lighthouse performance
  • โœ… SEO-friendly with canonical URLs and OpenGraph data
  • โœ… Sitemap support
  • โœ… RSS Feed support
  • โœ… Markdown & MDX support
  • โœ… PWA-ready
  • โœ… Fully responsive
  • โœ… Robots.txt & Humans.txt
  • โœ… TypeScript support
  • โœ… Syntax highlighting
  • โœ… YouTube Integration
  • โœ… CLI for adding new posts

โš“ Lighthouse Score - PWA Ready

Lighthouse Score

๐Ÿš€ Getting Started

Clone this repository to your local machine using Git.

git clone https://github.com/gndx/ev0-astro-theme.git your-project-name
Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run youtube Fetches the Latest YouTube Channel Videos
npm run newpost Generate a New Blogpost Markdown Entry

Edit the HTML files in the src/pages directory to add your projects, experiences, and personal information.

๐Ÿ“ Configuration Blog

To configure your blog, edit the src/config/config.json file. This file contains the following options:

{
  "site": {
    "title": "EV0 Astro Theme",
    "base_url": "https://ev0.gndx.io",
    "base_path": "/",
    "favicon": "/favicon.png",
    "logo": "https://s3.amazonaws.com/gndx.dev/ev0-astro-logo.png",
    "lang": "en",
    "description": "EV0 is a free and open-source serverless blog template, built with Astro, Tailwind CSS, and TypeScript.",
    "pageSize": 6
  },
  "metadata": {
    "meta_author": "Oscar Barajas @gndx",
    "meta_description": "EV0 is a free and open-source serverless blog template, built with Astro, Tailwind CSS, and TypeScript."
  },
  "author": {
    "name": "Oscar Barajas Tavares @gndx",
    "avatar": "https://s3.amazonaws.com/gndx.dev/gndx-astro-avatar.png",
    "bio": "EV0 is a free and open-source serverless blog template, built with Astro, Tailwind CSS, and TypeScript."
  }
}

The menu is configured in the src/config/menu.json file. This file contains the following options:

[
  {
    "name": "Home",
    "url": "/"
  },
  {
    "name": "Blog",
    "url": "/blog"
  },
]

Social networks are configured in the src/config/social.json file. This file contains the following options:

  {
    "name": "Instagram",
    "url": "https://instagram.com/gndx"
    "svg": "...."
  }

๐ŸŽฅ YouTube Integration

To integrate your YouTube channel, you need to create a new file called .env in the root directory of your project. Then add the CHANNEL_ID and API_KEY to get the latest videos from your YouTube channel in src/config/youtube.json.

npm run youtube

Your YouTube API is not used in production.

Requires an API KEY for YouTube API V3 - Google Console

๐Ÿ“ Adding New Posts

To add a new post, run the following command:

npm run newpost

Follow the instructions and this will generate a new markdown file in the src/content/blog directory. Edit the file to add your post content.

๐Ÿ“‚ Project Structure

/
โ”œโ”€โ”€ public/
โ”‚   โ””โ”€โ”€ favicons/
โ”‚   โ””โ”€โ”€ fonts/
โ”‚   โ””โ”€โ”€ blog-placeholder.jpg
โ”‚   โ””โ”€โ”€ favicon.png
โ”‚   โ””โ”€โ”€ humans.txt
โ”œโ”€โ”€ scripts/
โ”‚   โ””โ”€โ”€ newpost.cjs
โ”‚   โ””โ”€โ”€ youtube.cjs
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”œโ”€โ”€ config/
โ”‚   โ”œโ”€โ”€ content/
โ”‚   โ”œโ”€โ”€ layouts/
โ”‚   โ””โ”€โ”€ pages/
โ”‚   โ””โ”€โ”€ styles/
โ”‚   โ””โ”€โ”€ env.d.ts
โ””โ”€โ”€ package.json
โ””โ”€โ”€ astro.config.mjs
โ””โ”€โ”€ tailwind.config.js
โ””โ”€โ”€ tsconfig.json
โ””โ”€โ”€ .gitignore

๐Ÿš€ Release History

  • 1.0.0: Initial Release ๐Ÿš€ - (18/09/23)

๐Ÿ’ป Contributing

Contributions to this project are welcome. If you find a bug or have a suggestion for improvement, please open an issue or submit a pull request.

๐Ÿ“ƒ License

This project is licensed under the MIT License. See the LICENSE file for details.

โ˜• Support

If this project helped you learn something new, or if you're feeling particularly generous, you can buy me a coffee. It's greatly appreciated! ๐Ÿ˜Š GitHub Sponsors

gndx.dev's People

Contributors

gndx avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

nebula-gers

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.