devfolio

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 section.

Support this non-profit open-source project with a little sponsor ❤️ or Buy Me a Coffee ☕.

Here the Sample Performance of the devfolio measured by Lighthouse in Chrome DevTools.

Table of Contents

• Getting Started
• Available Scripts
  • npm run dev
  • npm run build
  • npm start
  • npm run lint
• Icons Information
• Vector Graphics Animations
• More Information
• Support Me
• License
• Contributing
• • Want to Contribute?
• Deploy on Vercel
• 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 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 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 to view it in the browser.

npm run lint

Runs the Next.js ESLint linter.
It will show lint errors in the console.

Icons Information

💖 Icons are from Font Awesome, Devicon, and also Google Fonts.

Vector Graphics Animations

✨ Vector Graphics Animations are from LottieFiles.

More Information

This documentation is built with Next.js and MDX powered by fumadocs. Please Read the Next.js Documentation. Also, Read the React.js Documentation.

Support Me

License

This project is licensed under the MIT License. See the LICENSE 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

Want to contribute?

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

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

This Project Also Supports Vercel and comes with (Vercel Analytics pre-enabled in it) you can Host it there if you like it

Check out the Next.js deployment documentation for more details.

✅ See latest release version for production use!

Stay Connected!