Skip to content

fac-23/today-i-learned

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to Today I learned (TIL)TIL

What is TIL?

today-i-learned

TIL is a platform for sharing on-the-job developer learnings with FAC alumni. Sharing real life code examples on a personal blog or website is not always appropriate due to the private nature of production code, but sharing some details of actual code is important for learning. TIL is a secure environment to share code with FAC alumni, the site was built using Next.js static site generation, Shiki syntax highlighting and Github as a backend for versioning and storage.

How do I use TIL?

  • Sign in with a single click using your google account or sign up via auth0.
  • Once you are signed in you will be able to browse the latest posts or view the archive to see all content
  • Each post has a link to a github markdown file stored in /posts. Want to edit or update a page? Simply make your changes online on github and commit to main, in under 3 mins your changes will appear on the live site.
  • Have your own learning to share? Great! Simply download a Template.md. Then upload here.
  • If you would prefer to clone the repo and make a pull request with your new markdown files, that's also a good option, especially if you want to share images and videos. Please store any media in /public/post-media

Publishing guidance

  • All markdown files should have a title, date, label and author in the following format to be rendered correctly (no line breaks):
---
title: "template-file"
date: "2022-03-05"
label: "react"
author: "bob ross"
---

Improving the site

  • Pull requests, issues and contributions welcome! It would be great to build a platform that works for everyone. The foundation for the site was the next.js blog starter so much of the code will be familiar.

  • Happy to share environmental variables on request. Although everything can be run locally with auth0 credentials https://auth0.com/docs/quickstart/webapp/nextjs/01-login and a supabase postgres connection string.

AUTH0_SECRET='######'
AUTH0_BASE_URL='http://localhost:3000'
AUTH0_ISSUER_BASE_URL='####'
AUTH0_CLIENT_ID='#####'
AUTH0_CLIENT_SECRET='#####'
DATABASE_URL='postgresql://postgres########.supabase.co:5432/postgres'

About

Online space to share on the job learning and code snippets

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published