Code Monkey home page Code Monkey logo

auto-annotated-portfolio's Introduction

Auto-annotated Example: Developer Portfolio Site

Developer Portfolio

This is a full-fledged portfolio website built with Next.js, Tailwind & the Git Content Source.

The codebase showcases how to apply annotations at scale, meaning: how to make much of your components highlightable in the visual editor through data attributes without manually adding code throughout the codebase.

This is achieved by:

  1. Adding an annotation property to the content objects at they're loaded (see src/utils/content.ts)
  2. When rendering the page, each content sub-object is dynamically matched to the appropriate component. At this point, wrap each component with an annotation, based on the abovementioned content property. See src/components/components-registry.tsx.

โšก Demo: auto-annotated-portfolio.netlify.app

Getting Started

The typical development process is to begin by working locally. Clone this repository, then run npm install in its root directory.

Run the Next.js development server:

cd auto-annotated-portfolio
npm run dev

Install the Netlify Create CLI. Then open a new terminal window in the same project directory and run the Netlify Create Dev server:

npm install -g @stackbit/cli
stackbit dev

This outputs your own Netlify Create URL. Open this, register or sign in, and you will be directed to Netlify Create's visual editor for your new project.

Next.js Dev + Netlify Create Dev

Next Steps

Here are a few suggestions on what to do next if you're new to Netlify Create:

Support

If you get stuck along the way, get help in our support forums.

auto-annotated-portfolio's People

Contributors

tomasbankauskas avatar renovate[bot] 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.