DEV Community 👩‍💻👨‍💻

Cover image for Create a beautiful personal website with react, ChakraUi and framerMotion
Muhammad  Ahmad
Muhammad Ahmad

Posted on • Updated on

Create a beautiful personal website with react, ChakraUi and framerMotion

Demo Link: Portfolio
GitHub Repo: Repo

Pages

  • Home Page
    • Intro
    • Highlights
    • Achievements
    • Projects
  • Achievements
    • Show progress yearly wise
  • About
    • Career
    • Education
  • Open-source
    • open-source repositories list (card design)
  • Blog
    • Published articles list

Built with


Update

Open-source page
  • Used github rest api to fetch user repositories
  • Updated page design with react-stack-grid
  • Used loading skeleton

Top comments (0)

Timeless DEV post...

How to write a kickass README

Arguably the single most important piece of documentation for any open source project is the README. A good README not only informs people what the project does and who it is for but also how they use and contribute to it.

If you write a README without sufficient explanation of what your project does or how people can use it then it pretty much defeats the purpose of being open source as other developers are less likely to engage with or contribute towards it.