Git Product home page Git Product logo

charm's Introduction

Personal Website

This is personal website hosted here built with Next.js, Tailwind CSS and hosted with Vercel.

๐Ÿ›  Installation & Set Up

  1. Clone this repository

    git clone https://github.com/ugistelmokaitis/charm.git
  2. Change directories

    cd charm
  3. Install dependencies

    yarn install
  4. Create a .env.local and following the example input some environment variables so that can run normally.

    NEXT_PUBLIC_SITE_URL=    
    NEXT_PUBLIC_PRISMIC_ENDPOINT=""    
    NEXT_PUBLIC_PRISMIC_ACCESS_TOKEN=""    
    NEXT_PUBLIC_EMAIL_PASSWORD=""      
    NEXT_PUBLIC_EMAIL_ADDRESS=""       
    TWITTER_BEARER_TOKEN=""        

๐Ÿ” Verify Prismic

  1. Verify acc in terminal

    prismic login
  2. See Customization Prismic section

๐Ÿ—๏ธ Building and Running for Production

  1. Generate a full static production build

    yarn run dev
  2. Preview the site as it will appear once deployed

    yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

  1. Access Prismic Slicemachine
yarn run slicemachine

Open http://localhost:9999 with your browser to see the result.

More details What is prismic slice machine?

โœ๏ธ Customization Prismic

  1. Settings - Header, Footer & Theme customization.
  2. About - pages/about
  3. Blog - pages/blog
  4. Home - pages/index.tsx
  5. Gear - pages/gear
  6. Extensions - pages/extensions
  7. Contact - pages/contact
  8. Privacy - pages/privacy
  9. Terms - pages/terms
  10. Server error - pages/500.tsx
  11. NotFound - pages/404.tsx

! Create blog posts on prismic - green button on right hand side "Create New"

๐Ÿ“ Files to customize

  • public/manifest.json - specify basic metadata about your extension such as the name...

  • public/* - replace all png files which contains my logo with your own logo.

  • fonts - ensure you have the license for the fonts I use for this website. The font I use find here.

  • components/layout.tsx - update: name, username, type: to your personal information .

  • pages/_app.tsx - update meta information content section.

  • public/ - store assets such as images and favicons.

  • components/externalLink.tsx - change link to your own website link.

  • tailwind.config.js and styles/* - contain the tailwind stylesheet which can be modified to change the overall look and feel of the site if needed.

  • pages - pages to route to. Read the Next.js documentation for more information.

  • next.config.js - configuration related to Next.js. You need to adapt the Content Security Policy if you want to load scripts, images etc. from other domains.

  • utils/gtag.ts - add your own google tag

    export const GA_TRACKING_ID = ".....";

๐Ÿ“š Tech Stack

Tool Link
Framework Next.js
CMS Prismic
Deployment Vercel
CSS Framework Tailwindcss
Favicon realfavicongenerator

๐Ÿš€ Deploy

Vercel
The easiest way to deploy the template is to use the Vercel Platform from the creators of Next.js. Check out the Next.js deployment documentation for more details.

Deploy with Vercel

! Also ensure that Environment Variables are appropriately copied and saved from .env.local file to vercel before deploying.

โœŒ๏ธ Protecting Copyright of designer work

Note that most of website icons belongs to ยฉ Copyright 2022-2099 Bonnie Hong

charm's People

Contributors

dependabot[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.