Skip to content

README.md

Latest commit

 

History

History
73 lines (52 loc) · 1.7 KB

README.md

File metadata and controls

73 lines (52 loc) · 1.7 KB

PORTFOLIO

A simple CLI Portfolio built with TypeScript and Vite image

Table of Contents

Introduction

This project is a command-line interface (CLI) styled portfolio website. It showcases various commands that display information about the developer, projects, work experience, and more.

Features

  • CLI styled interface
  • Display ASCII art banner
  • View resume and projects
  • Display education and work experience
  • Interactive commands

Installation

To get started with this project, clone the repository and install the dependencies:

git clone https://github.com/AravCodes/PORTFOLIO.git
cd PORTFOLIO
npm install

Usage

To run the project locally, use the following command:

npm run dev

This will start a development server and you can view the portfolio at http://localhost:3000.

Commands

Here are some of the available commands:

  • about: Who made this website?
  • projects: Maybe there's something interesting.
  • whoami: A perplexing question.
  • repo: View the GitHub repository.
  • banner: Display the banner.
  • resume: View my resume.
  • clear: Clear the terminal.
  • edu: My Qualifications.
  • work: My Work Experience.

Deployment

To deploy the project to GitHub Pages, use the following commands:

npm run predeploy
npm run deploy

The project will be deployed to Github Pages.

License

This project is licensed under the MIT License. See the LICENSE file for more details.