Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tejastn10/nimbus

A personal portfolio built with Next.js and shadcn, designed to showcase projects and achievements with a sleek, developer-friendly design.
https://github.com/tejastn10/nimbus

nextjs shadcn-ui tailwindcss typescript vercel

Last synced: 15 days ago
JSON representation

A personal portfolio built with Next.js and shadcn, designed to showcase projects and achievements with a sleek, developer-friendly design.

Host: GitHub
URL: https://github.com/tejastn10/nimbus
Owner: tejastn10
License: mit
Created: 2024-11-07T17:09:12.000Z (3 months ago)
Default Branch: main
Last Pushed: 2025-01-18T00:37:56.000Z (18 days ago)
Last Synced: 2025-01-18T01:29:52.279Z (18 days ago)
Topics: nextjs, shadcn-ui, tailwindcss, typescript, vercel
Language: TypeScript
Homepage: https://tejastn10.com
Size: 804 KB
Stars: 2
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

# Nimbus ☁️

![Node.js Version](https://img.shields.io/badge/Node.js-22%2B-339933?logo=nodedotjs&logoColor=white)
![TypeScript](https://img.shields.io/badge/TypeScript-5%2B-007ACC?logo=typescript&logoColor=white)
![React](https://img.shields.io/badge/React-19%2B-61DAFB?logo=react&logoColor=white)
![Next.js](https://img.shields.io/badge/Next.js-15%2B-000000?logo=nextdotjs&logoColor=white)
[![Vercel Deployment](https://img.shields.io/badge/Deployed%20on-Vercel-000000?logo=vercel&logoColor=white)](https://vercel.com)
![License](https://img.shields.io/badge/License-MIT-yellow?logo=open-source-initiative&logoColor=white)

**Nimbus** is a sleek and interactive portfolio website built with [Next.js](https://nextjs.org). It showcases your projects, skills, and experience in an elegant way while incorporating dynamic content and animations. The project draws inspiration from the [Magic UI Portfolio Template](https://portfolio-magicui.vercel.app/) and is tailored for uniqueness.

---

## Features 🌟

- **Dynamic Content**: Showcases projects, skills, and blog posts dynamically.
- **Custom Animations**: Smooth transitions and modern animations enhance UX.
- **Responsive Design**: Fully optimized for desktops, tablets, and mobile devices.
- **Theming**: Built-in light and dark mode toggle.
- **Optimized Fonts**: Includes `Geist` font, optimized via `next/font`.
- **Effortless Deployment**: Designed for seamless deployment on Vercel.
- **Blogging**: Support for blogging (Markdown-based).

---

## Getting Started 🚀

### Prerequisites

Ensure you have the following installed:

- **Node.js**: v22 or later.
- **Package Manager**: `npm`, `yarn`, `pnpm`, or `bun`.

---

### Installation ⚙️

1. Clone the repository:

```bash
git clone https://github.com/your-username/nimbus.git
cd nimbus

2. Install dependencies:

```bash
npm install
```

3. Start the development server:

```bash
npm run dev
```

4. Open your browser at `http://localhost:3000` to see Nimbus in action.

---

### Deployment 📦

Nimbus is designed to be deployed effortlessly on Vercel.

For more deployment options, check out the Next.js [Deployment Documentation](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme).

---

### Project Structure 📂

```bash
nimbus/
├── content/ # Directory for blogs or other dynamic content
├── public/ # Static assets like images, fonts, and favicon
├── src/ # Main source code directory
│ ├── app/ # Next.js App directory (for routing, layouts, and pages)
│ ├── components/ # Reusable React components (e.g., BentoGrid, ProjectCard)
│ ├── containers/ # Page-specific container components
│ ├── constants/ # Application-wide constants (e.g., values, themes)
│ ├── data/ # Static or dynamic data (e.g., projects, resume info)
│ ├── utils/ # Utility functions for common operations
├── next.config.js # Next.js configuration file
├── tsconfig.json # TypeScript configuration file
├── postcss.config.mjs # PostCSS configuration file for TailwindCSS
├── tailwind.config.ts # TailwindCSS configuration file
├── .prettierrc.yml # Prettier configuration for code formatting
├── .commitlintrc.yml # Commitlint configuration to enforce commit message conventions
├── .eslintrc.yml # ESLint configuration for linting JavaScript/TypeScript
├── .nvmrc # Node version file to specify the Node.js version
├── package.json # Dependencies and npm/yarn scripts
├── LICENSE.md # License for the project
└── README.md # Project documentation
```

---

## License 📜

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

## Acknowledgments 🙌

- Nimbus was inspired by the excellent [Magic UI Portfolio Template](https://portfolio-magicui.vercel.app/). A big thanks to the creators for providing a foundation to build upon.
- Inspired by the mythological **Nimbus**, a radiant cloud often associated with divine presence.
- Built with ❤️ and Next.js.