INSTALLATION.md

Nim - Installation Guide

Prerequisites

• Node.js 20.x or later
• Git

Installation Steps

1. Clone the repository

   git clone https://github.com/ibelick/nim.git
   cd nim

2. Install dependencies

   npm install

3. Run the development server

   npm run dev

4. Update the template data

   Update the template data in the app/data.ts file.

   export const EMAIL = '[email protected]'
   
   export const SOCIAL_LINKS = [
     {
       label: 'Github',
       link: 'your-github-url',
     },
     // Add your social links
   ]
   
   ...

5. Add your blog posts

Create a new .mdx file for each blog post inside the app/blog folder. For example: app/blog/your-article-slug/page.mdx.

Example blog post structure in .mdx:

# Your Article Title

Introduction

Your content here...

## Code Examples

// Example code block here...

Note: You can use all MDX features, including React components, in your blog posts.

6. Project Structure

For a better understanding of the Next.js project structure, refer to the Next.js documentation.

7. Additional Features

Want to add more animated components? Check out Motion-Primitives for additional animation components and templates. If you want something else DM on X.

8. Deployment

You can deploy your site to any hosting platform that supports Next.js. For the easiest deployment experience, consider using Vercel: