Skip to content

Personal portfolio website, built with Astro starter kit

License

Notifications You must be signed in to change notification settings

maacpiash/portfolio

 
 

Repository files navigation

🙏🏽 Huge thanks to Stefan Gogov, the original creator of this project, for keeping it under GPLv3 licence, allowing me to copy, modify, and deploy the project for myself.

Important notice about branches

This fork has two new branches: trunk and prod. In the trunk branch, I have been trying to keep the original version as clean as possible while keeping the packages up-to-date and adding slight modifications in tooling and code cleanup. The prod branch, which is set as the default one, contains a personalised version of what's in the trunk branch.

So, if you want to fork from here and modify it, consider doing so on top of the trunk branch:

# After forking
git clone https://github.com/YOUR-USERNAME/YOUR-FORK.git
cd YOUR-FORK

# Add this remote as `upstream` and fetch the `trunk` branch
git remote add upstream https://github.com/maacpiash/portfolio.git
git fetch upstream trunk

# Create a new branch on top of `upstream/trunk`
git checkout -b NEW-BRANCH-NAME upstream/trunk

# After committing your work, push to your fork
git push -u origin NEW-BRANCH-NAME

The original readme content follows.


Portfolio Website using Astro Starter Kit

Astro License

About the Project

This is a portfolio website built using Astro, a static site generator that delivers lightning-fast performance and embraces the JAMstack philosophy. The blog is built using the Astro starter kit

Pages

  • Home
  • About
  • Projects
  • Contact

How to Contribute

If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Make your enhancements or additions.
  4. Submit a pull request, describing the changes you've made.

Getting Started

To run the project locally, you'll need Node.js and npm installed on your system. Follow these steps to get started:

  1. Clone this repository to your local machine.
  2. Install the project dependencies with npm install.
  3. Start the development server with npm run dev.
  4. Open your browser and visit http://localhost:3000 to see the project in action.

Project Structure

Inside of your Astro project, you'll find the following directories and files:

/
├── public/
│   └── ...
├── src/
│   ├── components/
│   │   └── ...
│   ├── layouts/
│   │   └── ...
│   └── pages/
│       └── ...
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

Any static assets, like images, can be placed in the public/ directory. These files will be copied into the final build.

Reporting Issues

If you come across any bugs, have suggestions for improvements, or want to request new features, please submit an issue in the GitHub repository. Your feedback is highly appreciated!

License

This project is licensed under the General Public License v3.0. See the LICENSE file for details.

About

Personal portfolio website, built with Astro starter kit

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Astro 68.9%
  • TypeScript 18.9%
  • SCSS 9.5%
  • JavaScript 2.7%