Skip to content

A simple editor allows you to easily add and customize all the sections you need for your profile's readme.

License

Notifications You must be signed in to change notification settings

varunKT001/tomper-readmify

Repository files navigation

Create your Profile README using the best Templates

tomper-readmify.onrender.com


This is the frontend + backend of TomperReadmify build with MERN stack and deployed with Render

🚀 Visit TomperReadmify

🧾 Description

A simple editor allows you to easily add and customize all the sections you need for your profile's readme.

✨ Features

Users creating their profile's README through this platform enjoys following features:

  • Easy to interface.
  • No markdown knowledge is required.
  • Various themes to suit every user's need.
  • Addons like Github Streaks, Github Stats, Profile Views, etc., each with a variety of themes.
  • Feedback can be provided by users.
  • Responsive for all screen sizes.

⚙ Tools and Technologies used

Client

  1. React.js
  2. Typescript
  3. Redux-Toolkit
  4. Chakra-UI
  5. Marked
  6. DOMPurify
  7. React-icons
  8. Formspree

Backend

  1. Node.js
  2. Express.js
  3. Typescript
  4. @varuntiwari/express-ts-decorators

🛠 Installation and setup

  1. Clone the repo to your local machine.

  2. Install the required dependency for the client and the server using :

    npm run installScripts
  3. Start the dev server using :

    npm run dev

🏎 Creating production built

  1. Create a production ready MERN app using the command :

    npm run build

😎 Made with by

GSSoC'22
Varun Kumar Tiwari
2020IMT-112
LinkedIn Github

⚖ License

GPL-3.0




(If you liked the project, give it a star 😃)