ResuME - Website Generator

A CLI Tool to build and deploy beautiful websites in under 5 minuites

Hey there 👋🏽, I'm Ishita and I've made this project to help fellow developers build and deploy their portfolio websites within minuites. 🧁

Table of Contents

• Installation
• Usage
  • Requirements
  • Integration with Github
  • Commands and Features
• Bugs and Feature Requests
• Frequently Asked Questions
• Contributing

Installation

You can find all versions of the CLI here:

To install the CLI:

• run the command:

pip install resume-cli

Usage

Requirements

To be able to use the CLI you must have the following installed and working:

• Python
• Git CLI

Integration with Github

To have a github project show up on the website, add the topic: resume-cli to it.

Commands and Features

ResuMe has a bunch of cool features:

• to configure the CLI run:

  resume-cli init
  

  this is a one-time step.

• to build a website using your linkedin and github accounts:

  resume-cli build
  

  This command creates a website and pushes it to your github account.

• to deploy the website:

  resume-cli deploy
  

  This command deploys the website to github pages

• to list all your websites:

  resume-cli list
  

• to delete a website:

  resume-cli delete
  

  Important Note: Please do not delete the local copy or the repository manually What if i have already deleted my github repository or my local copy:

  • Incase you have deleted your local copy, please delete the corresponding github repository.
  • Incase you have deleted your github repository, please delete the corresponding local copy.

• to update your website:

  resume-cli update
  

Bugs and Feature Requests

• Please add your bug report or feature request to the issues tab with an appropriate label.
• Make sure to look through the issues to not create a duplicate issue

Frequently Asked Questions

• How do i generate my github PAT:

  Head over to your github account, you can create your PAT under:
  settings > developer settings > Personal access tokens
  

• What permissions to give to my PAT:

  repo: Full control of private repositories
  delete_repo: Delete repositories