Skip to content

marcin-slezak/winged-code-digital-garden

Repository files navigation

Winged Code Digital Garden

It's new version of wingedcode.com website in a form of digital garden. Digital Garden is an online space at the intersection of a notebook and a blog. The goal is to share knwoledge managed by https://obsidian.md/ application that save a content in markdown files.

Featres / Constrains

  • use Static Site Generator and host on dummy server
  • automate deploy to dummy server via sftp
  • be able to build pages using react + custom css and generate pages from Obsidian markdown files
  • manage to display a snippets of code in some nice way
  • make page super fast (including aprsing markdown to html on build time)

Technical side

This project is using Next.js framework including TypeScript and React. To learn more about Next.js, take a look at the following resources:

Configuration

I'm using enviroment variables. For development purposes you can create .env file with following content:

NEXT_PUBLIC_GA_TRACING_CODE=XXXXXXX
NEXT_PUBLIC_DOMAIN=https://wingedcode.com
FTP_HOST=xxx
FTP_USER=xxx
FTP_PASSWORD=xxx

where:

  • NEXT_PUBLIC_GA_TRACING_CODE - Google Analitics tracking code (optional)
  • NEXT_PUBLIC_DOMAIN - domain that will be used to generate sitemap.xml (optional)
  • FTP_HOST - ftps server address, used to deploy generated website to dump server via ftp (optional)
  • FTP_USER - ftp user (optional)
  • FTP_PASSWORD - ftp password (optional)

How to run application

Dependencies: nodejs, npm and git.

To run development enviroment

  1. Download repository
  2. install dependencies npm install
  3. run server npm run dev
  4. open in browser http://localhost:3000 to see webiste

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published