Home

Awesome

<div align="center"> <img alt="Logo" src="https://github.com/pycoder2000/blog/raw/master/public/static/images/logo.png" width="100" /> </div> <h1 align="center"> Personal Blog - <em>Mere Musings</em> </h1> <p align="center"> This is my personal portfolio blog hosted <a href="https://musing.vercel.app/" target="_blank">here</a> built with <a href="https://nextjs.org/" target="_blank">Next.js</a>, <a href="https://tailwindcss.com/" target="_blank">Tailwind CSS</a> and hosted with <a href="https://www.vercel.com/" target="_blank">Vercel</a>. </p> <p align="center"> The original template is designed by <a href="https://github.com/timlrx" target="_blank">Timothy Lin</a> and can be found <a href="https://github.com/timlrx/tailwind-nextjs-starter-blog" target="_blank">here</a>. The demo for the same can be found <a href="https://tailwind-nextjs-starter-blog.vercel.app/" target="_blank">here</a>. </p> <div align="center">

<a href="https://musing.vercel.app/" target="blank" >View Demo</a> <a href="https://github.com/pycoder2000/blog/issues/new?assignees=&labels=bug&template=bug_report.md&title=">Report Bug</a> <a href="https://github.com/pycoder2000/blog/issues/new?assignees=&labels=&template=feature_request.md&title=">Request Feature</a> <a href="https://github.com/pycoder2000/blog/fork">Fork</a> <img src="https://img.shields.io/github/stars/pycoder2000/blog?color=darkgreen&style=for-the-badge">

</div>

demo

<div align="center">

Next JS Vercel TailwindCSS Node.js TypeScript Prisma

</div>

šŸ›  Installation & Set Up

  1. Clone this repository

    gh repo fork repository --clone=true
    
  2. Change directories

    cd blog
    
  3. Install and use the correct version of Node using NVM

    nvm install
    
  4. Install dependencies

    npm install
    
  5. Start the development server

    npm start
    
  6. Create a .env.local and following the .env.example input some environment variables so that can run normally.

    NEXT_PUBLIC_GISCUS_REPO=
    NEXT_PUBLIC_GISCUS_REPOSITORY_ID=
    NEXT_PUBLIC_GISCUS_CATEGORY=
    NEXT_PUBLIC_GISCUS_CATEGORY_ID=
    EMAILOCTOPUS_API_URL=
    EMAILOCTOPUS_API_KEY=
    EMAILOCTOPUS_LIST_ID=
    DATABASE_URL=
    OAUTH_CLIENT_KEY=
    OAUTH_CLIENT_SECRET=
    NEXTAUTH_URL=
    SECRET=
    TWITTER_API_KEY=
    TWITTER_BEARER_TOKEN=
    SPOTIFY_CLIENT_ID =
    SPOTIFY_CLIENT_SECRET =
    SPOTIFY_REFRESH_TOKEN =
    

šŸ—ļø Building and Running for Production

  1. Generate a full static production build

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

    npm run serve
    

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

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

šŸ‘Øā€šŸŽØļø Customization

  1. Personalize siteMetadata.js (site related information)
  2. Modify the content security policy in next.config.js if you want to use any analytics provider or a commenting solution other than giscus.
  3. Personalize authors/default.md (main author)
  4. Modify projectsData.js
  5. Modify headerNavLinks.js to customize navigation links
  6. Add blog posts

šŸ“ Files to customize

šŸ”Ø Compose

Run node ./scripts/compose.js to bootstrap a new post.

Follow the interactive prompt to generate a post with pre-filled front matter.

šŸ“š Tech Stack

ToolLink
FrameworkNext.js
ORMPrisma
DatabasePlanetScale
AuthenticationNextAuth.js
DeploymentVercel
StylingTailwindcss
CommentTailwindcss
NewsletterEmail Octopus
Faviconrealfavicongenerator
ContentMDX

šŸ“ˆ Stats

<img src="https://img.shields.io/website?down_color=red&down_message=offline&style=for-the-badge&up_color=green&up_message=online&url=https%3A%2F%2Fmusings.vercel.app"> <img src="https://img.shields.io/github/repo-size/pycoder2000/blog?style=for-the-badge&color=darkgreen" /> <img src="https://img.shields.io/github/languages/top/pycoder2000/blog?style=for-the-badge" /> <img src="https://img.shields.io/github/commit-activity/m/pycoder2000/blog?style=for-the-badge&color=orange" /> <img src="https://img.shields.io/github/deployments/pycoder2000/blog/Preview%20ā€“%20blog?style=for-the-badge" /> <a href="https://tech-blogs.dev" target="_blank" >Featured on tech-blogs.dev</a> <a href="https://makeapullrequest.com" target="blank" >PRs Welcome</a>

šŸŖœ Project structure

šŸ“¦ root
ā”œā”€ā”€ šŸ—‚ļø components             # React files to customize the components for the site
ā”œā”€ā”€ šŸ—‚ļø css                    # Tailwind and Prisma CSS files
ā”œā”€ā”€ šŸ—‚ļø data                   # Files to change the content of pages
ā”‚ ā”œā”€ā”€ šŸ—‚ļø authors              # Markdown files for authors of blog
ā”‚ ā”œā”€ā”€ šŸ—‚ļø blog                 # Markdown files for blog posts
ā”‚ ā””ā”€ā”€ šŸ—‚ļø snippets             # Markdown files for code snippets
ā”œā”€ā”€ šŸ—‚ļø layouts                # Templates for pages
ā”œā”€ā”€ šŸ—‚ļø lib                    # Non-react modules
ā”œā”€ā”€ šŸ—‚ļø pages                  # Page files for website
ā”œā”€ā”€ šŸ—‚ļø public                 # Static files for images, rss, and assets
ā”‚ ā”œā”€ā”€ šŸ—‚ļø static               # Holds images, favicons, and other assets
ā”‚ ā”‚ ā”œā”€ā”€ šŸ—‚ļø favicon            # Favicon files
ā”‚ ā”‚ ā””ā”€ā”€ šŸ—‚ļø images             # Image Files
ā”‚ ā”œā”€ā”€ šŸ“ feed.xml             # RSS feed
ā”‚ ā”œā”€ā”€ šŸ“ robots.txt           # Helps crawlers to crawl your site
ā”‚ ā””ā”€ā”€ šŸ“ sitemap.xml          # Sitemap
ā”œā”€ā”€ šŸ—‚ļø scripts                # Scripts to run for different tasks
ā”œā”€ā”€ šŸ“ tailwind.config.js     # Contains tailwind stylesheet to change the look
ā””ā”€ā”€ šŸ“ next.config.js         # configuration related to Next.js

šŸ“Š Google Lighthouse Performance Metrics

Google Lighthouse Performance Metrics

šŸš€ 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

šŸ° Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project

  2. Commit your Changes

    git commit -m 'Add some Feature'
    
  3. Push to the Branch

    git push origin main
    
  4. Open a Pull Request

<div align="center">

<a href="https://makeapullrequest.com" target="blank" >PRs Welcome</a>

</div>