Skip to content

Latest commit

 

History

History
196 lines (148 loc) · 7.07 KB

README.md

File metadata and controls

196 lines (148 loc) · 7.07 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

Portfolio Page

A portfolio built on top of Svelte Kit
View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

This developer portfolio project was built using Svelte Kit, SCSS, and TypeScript. It serves as a platform to showcase my work and skills to potential employers or clients, and includes a list of my past projects with descriptions and live demos/code repositories. The website also includes a section highlighting my skills and experience, as well as a contact feature for easy communication. The goal of this project is to give an understanding of my capabilities and personality as a developer, and to provide a way for potential employers or clients to reach out to me.

(back to top)

Built With

  • Svelte
  • Typescript
  • SCSS

(back to top)

Getting Started

Prerequisites

To setup and run this project locally, you will need to have NodeJS and NPM installed. It is also recommended to use Yarn for package management.

  • npm

    npm install npm@latest -g

  • Yarn

    corepack prepare yarn@stable --activate

Installation

  1. In the project folder, run yarn or npm install to install all necessary packages.
  2. Create a Discord Webhook URL and add it to the .env file.
  3. Start the website in development mode by running yarn run dev or npm run dev.

(back to top)

Hosting

It is recommended to host this portfolio using Vercel and the default Svelte Kit configuration. If you prefer to use a different hosting platform, you will need to modify the adapter in the svelte.config.js file. Consult the documentation for more information on how to do this.

(back to top)

Roadmap

  • Contact Feature
  • i18 inclusion for German
  • Analytics
  • Improved projects section
    • Add proper previews for every project
    • Include all used technologies
    • Allow filtering
    • Own Page for all projects and only showcase specific projects on the main side
  • Make the design more personal and unique

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 MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Michael - @Officer_Pum

Project Link: https://github.com/PumPum7/svelte-portfolio