Website

My personal website/portfolio to learn more about me :-)
View Website »

Explore the docs · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Acknowledgments

About The Project

A personal website/portfolio to showcase my skills and expertise in the hopes of getting better opportunities in the realm of software development.

Incentives:

• Wanted a centralised place to keep track of my note-worthy projects.
• Allows people to get to know about me quickly.

The crux of the project is to implement a clean and responsive UI as designing is not my forte. However, I am glad how things turned out in the end. Needless to say, there is still a lot of room for improvement but I'll leave that in the future.

(back to top)

Built With

The technologies and tools used within this template.

• Vue2
• Nuxt2
• Sass
• Pug
• Vercel

(back to top)

Getting Started

Prerequisites

The list of development tools used.

• npm

  npm install npm@latest -g

• yarn

  npm i -g yarn

• Git

Installation

To run this template project in your local for personal use or contribution, simply perform the following.

1. Clone the repo

   git clone https://github.com/data-miner00/portfolio.git

2. Install Node dependencies

   yarn

3. Start the development server

   yarn dev

4. Build project

   yarn generate

(back to top)

Roadmap

• Add readme
• Add Styling
  • Sass
  • Stylelint
• Add PWA Manifest
• Responsive styles
• Add to top button
• Add background decorations

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

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

(back to top)

Acknowledgments

List of resources that are helpful and would like to give credit to.

• Nuxt v2
• Sass
• Pug
• Yarn
• Vuex
• Vue 2
• Node.js 14 and 16 are being deprecated

(back to top)