📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
  • Tech Stack
  • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Microverse Portfolio

This a Microverse Project, for a fully responsive personal portfolio.

Microverse Portfolio is a fully responsive web application.

🛠 Built With

Tech Stack

HTML. CSS. LINTERS.

Key Features

• Uses html5 best practices.
• Uses css best practices.
• Utilises linter for testing.

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

 npm install

Setup

Clone this repository to your desired folder:

    cd portfolio_setup
    git clone https://github.com/peter-mwovi/portfolio_setup.git

Install

Install this project with:

  cd portfolio_setup
  npm install

Usage

To run the project, execute the following command:

    npm run build (it will create a production ready file)
    npm start (it will run the server on your machine)

Run

I have added linters to ensure proper practice in the project.

To run the linter tests on index.html, run the following command:

    npx hint .

Deployment

You can deploy this project using:

    https://vercel.com/

(back to top)

👥 Authors

👤 Peter MWovi

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Juan Carlos Muñoz

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [ ] Web Version
• [ ] Complete Mobile versio
• [ ] Fully responsive

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please follow me on my social media handles then go ahead and contribute.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing me with the necessary tools to work on this a project.

(back to top)

❓ FAQ

• What is Linters?

  • Linters is a tool to analyse Source code so as to flag errors.

• Do I need knowledge in javascript to contribute?

  • basic knowledge in javascript is required. However feel free to play around with the source code.

(back to top)

📝 License

This project is MIT licensed.

(back to top)