Giter Club home page Giter Club logo

ecosecrets-site's Introduction

ecoSecrets-site

ecoSecrets promotional site. Built using Next.js with TypeScript, it is intended to be hosted as a fully static site on GitHub Pages.

Principles

  • Static HTML (JavaScript used to enhance website, but not a requirement)
  • SEO friendly (includes sitemap)
  • Auto build/deploy (to facilitate updates)
  • Open source
  • Automatic image optimisation
  • Integration with GitHub API (for showing repositories and releases)

Getting Started

The site uses PNPM, an optimised version of NPM. To get started pnpm install then run pnpm dev for running the site in dev mode at http://localhost:3000.

Contributing

Please use Prettier to format code in the src/ directory, this is automatically checked by GitHub Actions before the site is built and deployed, and will fail if the code does not conform.

pnpm dlx prettier@latest --write src

Building

The site uses Next.js's "export" functionality. To build locally, run pnpm build and you can see the result in out/.

Architecture

  • public/ Static assets (images, icons)
  • src/ Main code
    • _posts/ Blog posts in Markdown format
    • components/dynamic/ Components for dynamic aspects of the page (API calls etc)
    • components/presentation/ Visual components (cards, features, etc)
    • components/posts/ Visual components for blog posts
    • interfaces/ TypeScript definitions
    • layout/ Header, footer etc
    • lib/ Helper libraries for transforming blog posts
    • pages/ Pages of the website (as per Next.js norms)
    • styles/ Bootstrap import plus variable overrides and custom SCSS

TODO

  • Fix alt text for images
  • Add font loading (Open Sans)

ecosecrets-site's People

Contributors

mathildens avatar

Watchers

 avatar Rovellotti avatar  avatar  avatar

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.