Tomper Readmify

• GIF

  Homepage

• 

  Cards Theme

• 

  Profile Views Theme

Inspiration

A GitHub Profile README plays a vital role when applying to jobs/internships. Learning Markdown and creating a GitHub Profile README is very time-consuming. You will need to find icons and images and also style the README properly, which takes a lot of time that people can utilize for learning other crucial skills. I developed this platform so students/developers can create a solid GitHub Profile README without writing a single line of Markdown. Just enter your details, and you are good to go 🚀

What it does

It's a simple editor that quickly adds and customizes all the sections you need for your GitHub Profile README.

How we built it

I build it using the MERN Stack. Instead of JavaScript, I choose to go with TypeScript to allow for some strict type checking and lesser bugs 🐛

Challenges we ran into

The most challenging task I faced was to keep the application performant. Because a ton of data flows between different components, optimizing the application was difficult. However, when I researched thoroughly, I found out that I can use Redux for state management. Despite a large amount of data, Redux handled it flawlessly. Combined with some Debouncing, I was able to optimize the application to a great extent.

Accomplishments that we're proud of

I'm proud of the fact that the platform which I thought of implementing is now up and running. Despite the challenges I faced, I was able to put everything together. A result is a fantastic tool that will assist many students in saving their time in creating a great Github Profile README and also in landing their dream job/internship 😄

What we learned

Through this project, I learned a lot about Redux and TypeScript and how we can use them to build excellent applications. I also learned how to handle data flow properly to keep the application performant for the end user.

What's next for Tomper Readmify

For now, I will work on creating as many awesome themes as possible so that people can choose from many options. In addition, I will try to accommodate more icon packs so that other themes can have different sets of icons.

Built With

• express.js
• github-stats-api
• github-streaks-api
• heroku
• node.js
• react.js
• typescript