README.md

Professional Portfolio

View Live Demo • Report a Bug

Table of Contents

1. About the Project

   • Built With
   • Resources Used

2. Getting Started

   • Prerequisites
   • Installation
   • Running with Docker
   • Deploying to Firebase

3. License

About

This repository is my professional porfolio containing my highlighted projects and side proojects.

Technology Stack

Resources Used

Getting Started 📌

Prerequisites

Before running the application, make sure to install the following:

1. NodeJS (NPM).

   Download through their official docs.

   npm install npm@latest -g

Installation

1. Clone this repository

   git clone https://github.com/genebit/portfolio.git

   Upon cloning, navigate to the repository.

2. Install NPM packages

   npm install

   That's it! You can now start by running the application.

3. Update the submodule for repo. cv. This is found under public\docs\cv

   git submodule init
   git submodule update --recursive --remote

4. Start the application

   npm run dev

Running with Docker

1. Clone the submodules first by running the command:

   git submodule init
   git submodule update --recursive --remote

2. Once cloned, run docker build . -t 3000:3000 "<project_name>:<tag>"

3. Launch the application under localhost:3000

Firebase Deployment

1. Initialize Firebase config. Answer the prompt and redirect it from public to dist. Because dist is the output build file for vite

   firebase init

2. Build the repo.

   npm run build

3. Deploy to Firebase

   firebase deploy

License ✍

Distributed under the MIT License. See LICENSE for more information.