https://github.com/muhammad-fiaz/devfolio

Welcome to my developer site! Here, I present documentation and details of various projects. Explore this open-source platform, built with Next.js and JavaScript, offering a dynamic and responsive showcase for my skills and work.
https://github.com/muhammad-fiaz/devfolio

blog developer-website docs documentation documentation-website fumadocs javascript nextjs nextjs-boilerplate nextjs-example nextjs-starter nextjs-template nextjs-typescript nextjs-website nextra portfolio typescript website

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/muhammad-fiaz/devfolio
Owner: muhammad-fiaz
License: mit
Created: 2022-01-30T06:45:00.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2025-02-08T06:55:59.000Z (4 months ago)
Last Synced: 2025-02-08T07:26:41.888Z (4 months ago)
Topics: blog, developer-website, docs, documentation, documentation-website, fumadocs, javascript, nextjs, nextjs-boilerplate, nextjs-example, nextjs-starter, nextjs-template, nextjs-typescript, nextjs-website, nextra, portfolio, typescript, website
Language: MDX
Homepage: https://projects.muhammadfiaz.com
Size: 1.12 MB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


  





  

docs.muhammadfiaz.com | devfolio


![Stability](https://img.shields.io/badge/stability-good-blue.svg) ![MIT License](https://img.shields.io/badge/license-MIT-green)

[![GitHub Repository](https://img.shields.io/badge/GitHub-Repository-blue)](https://github.com/muhammad-fiaz/devfolio)

[![Build Passing](https://badge.buildkite.com/sample.svg?status=passing)](https://github.com/muhammad-fiaz/devfolio)

[![CodeQL](https://github.com/muhammad-fiaz/devfolio/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/muhammad-fiaz/devfolio/actions/workflows/github-code-scanning/codeql)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/muhammad-fiaz/devfolio)

[![Maintainer](https://img.shields.io/badge/maintainer-muhammad--fiaz-blue)](https://GitHub.com/muhammad-fiaz)

![Next JS](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white)

![Vercel](https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white)

[![GitHub visitors](https://img.shields.io/github/contributors/muhammad-fiaz/devfolio.svg)](https://github.com/muhammad-fiaz/devfolio/graphs/contributors)

![GitHub stars](https://img.shields.io/github/stars/muhammad-fiaz/devfolio.svg?style=social&label=Stars)

[![Follow me on GitHub](https://img.shields.io/github/followers/muhammad-fiaz?label=Follow&style=social)](https://github.com/muhammad-fiaz)

[![Discord](https://img.shields.io/badge/Discord-Join%20us-7289DA?logo=discord&style=flat-square)](https://discord.gg/mXMhy2EX)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/F1F6MME1W)



Welcome to the official documentation website for my projects! We value your contributions to make our documentation more comprehensive and user-friendly.Make Sure to ⭐ the Repo if You liked it

> Note: This documentation is a work in progress. If you can't find what you're looking for, please refer to the [Contributing](#contributing) section.

**Support this non-profit open-source project with a little [sponsor ❤️](https://github.com/sponsors/muhammad-fiaz) or [Buy Me a Coffee ☕](https://buymecoffee.com/muhammadfiaz).**

Here the Sample Performance of the devfolio measured by [Lighthouse](https://developers.google.com/web/tools/lighthouse) in Chrome DevTools.



  



## Table of Contents

- [Getting Started](#getting-started)

- [Available Scripts](#available-scripts)

  - [`npm run dev`](#npm-run-dev)

  - [`npm run build`](#npm-run-build)

  - [`npm start`](#npm-start)

  - [`npm run lint`](#npm-run-lint)

- [Icons Information](#icons-information)

- [Vector Graphics Animations](#vector-graphics-animations)

- [More Information](#more-information)

- [Support Me](#support-me)

- [License](#license)

- [Contributing](#contributing)

- - [Want to Contribute?](#want-to-contribute)

- [Deploy on Vercel](#deploy-on-vercel)

- [Stay Connected!](#stay-connected)

## Getting Started

To run the project locally, follow these steps:

1. Clone the repository: `git clone https://github.com/muhammad-fiaz/devfolio.git`

2. Navigate to the project directory: `cd devfolio`

3. Install the dependencies: `npm install`

4. Start the development server: `npm run dev`

5. Open [http://localhost:3000](http://localhost:3000) in your browser to view the website.

## Available Scripts

In the project directory, you can run the following scripts:

### `npm run dev`

Runs the app in development mode.\

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.\

The page will reload if you make edits.\

You will also see any lint errors in the console.

### `npm run build`

Builds the app for production to the `.next` folder using default Next.js build config.\

It correctly bundles Next.js and optimizes the build for the best performance.

### `npm start`

Starts the production server to serve the built app.\

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

### `npm run lint`

Runs the [Next.js ESLint](https://nextjs.org/docs/basic-features/eslint) linter.\

It will show lint errors in the console.

## Icons Information

💖 Icons are from [Font Awesome](https://fontawesome.com/), [Devicon](https://devicon.dev/),

and also [Google Fonts](https://fonts.google.com/icons).

## Vector Graphics Animations

✨ Vector Graphics Animations are from [LottieFiles](https://lottiefiles.com/).

## More Information

This documentation is built with [Next.js](https://nextjs.org/) and [MDX](https://mdxjs.com/) powered by [fumadocs](https://fumadocs.vercel.app/).

Please Read the [Next.js Documentation](https://nextjs.org/docs/getting-started).

Also, Read the [React.js Documentation](https://reactjs.org/docs/getting-started.html).

## Support Me



💖 Show Your Support and Help My Non-Profit Open-Source Project! 💰


As an open-source enthusiast, I'm dedicated to creating free tools and resources for the community. Your contribution, no matter how small, helps me keep this project going and make it even better!




  

    

  

  

    

  



Thank you for your support! 🙏




## License

This project is licensed under the MIT License. See the [LICENSE](https://github.com/muhammad-fiaz/devfolio/blob/main/LICENSE.md) file for details.

## Contributing

Contributions are welcome!

If you find any bugs or have suggestions for improvements, please open an issue or submit a pull request.

And make sure to follow the [project guidelines](CODE_OF_CONDUCT.md)

### Want to contribute?

If you'd like to contribute to this project, please check out the [contributing guidelines](CONTRIBUTING.md), fork the repository, and submit a pull request. Every contribution is welcome and appreciated!

[![devfolio contributors](https://contrib.rocks/image?repo=muhammad-fiaz/devfolio&max=2000)](https://github.com/muhammad-fiaz/devfolio/graphs/contributors)

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

**This Project Also Supports [Vercel](https://vercel.com/dashboard) and comes with [(Vercel Analytics pre-enabled in it)](https://vercel.com/analytics) you can Host it there if you like it**

Check out the [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

✅ See [latest release](https://github.com/muhammad-fiaz/devfolio/releases/latest) version for production use!

## Stay Connected!