Skip to content

Latest commit

 

History

28 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌐 Personal Portfolio

Welcome to my personal portfolio repository!

You can view the deployed project at the following URL: https://jaromasta.github.io/

🧒 Template Author:

Astro web templates: https://astro.build/themes/details/sorollaportfolio/ Github: https://github.com/jramma/sorollaportfolio

📂 Project Structure

  • public/: Contains public assets like images and fonts.
  • src/: Includes the source code for the portfolio.
  • .gitignore: Specifies files and directories to be ignored by Git.
  • astro.config.mjs: Configuration file for Astro.
  • package.json: Lists project dependencies and scripts.
  • tailwind.config.mjs: Configuration file for Tailwind CSS.
  • tsconfig.json: TypeScript configuration file.

Deployment

The webiste runs on gh-pages branch, because githubPages allows only statically loaded websides.

Prerequisites

  • You have a local copy of your repository.
  • You have Bun installed (or use npm if preferred).

Steps to Update the Website

  1. Navigate to Your Project Directory

    cd path/to/your/repository
  2. Make Changes

    • Edit files as needed (HTML, CSS, Astro components, etc.).
  3. Build the Project

    bun run build

    This will generate the dist folder with the latest version of your website.

  4. Deploy to GitHub Pages

    bun run gh-pages -d dist

    This command publishes the contents of dist to the gh-pages branch.

  5. Commit and Push Changes to GitHub

    git add .
    git commit -m "Update website"
    git push origin main

    This ensures your repository stays up to date.

  6. Check the Live Site

    • Visit https://jaromasta.github.io/ to verify the changes.
  7. Troubleshooting

  • If styles or scripts are missing, check the base setting in astro.config.mjs:
    export default defineConfig({
      base: "/your-repo-name/",
    });
  • If deployment fails, ensure gh-pages is installed:
    bun add gh-pages

🧭 /src structure

The /src directory contains the main source code for the project. Below is an overview of its structure:

src
├── assets
│   ├── adriana.jpg
│   ├── euro.jpg
│   ├── fran.jpg
│   └── hero.png
├── components
│   ├── BaseHead.astro
│   ├── Footer.astro
│   ├── FormattedDate.astro
│   ├── Header.astro
│   ├── HeaderLink.astro
│   ├── Hero.astro
│   └── WhatIDo.astro
├── consts.ts
├── content
│   └── blog
│       └── content in markdown format
├── content.config.ts
├── icons
│   ├── 1.svg
│   ├── 2.svg
│   ├── 3.svg
│   ├── 4.svg
│   ├── 5.svg
│   ├── beach.svg
│   ├── github.svg
│   ├── linkedin.svg
│   ├── paint.svg
│   └── web.svg
├── layouts
│   └── BlogPost.astro
├── pages
│   ├── about.astro
│   ├── blog
│   │   ├── index.astro
│   │   └── [...slug].astro
│   ├── index.astro
│   └── rss.xml.js
└── styles
    ├── global.css
    └── hamburgers.css

Explanation

  • assets: Contains image files used in the project.
  • components: Contains reusable UI components built with Astro.
  • content: Contains blog content in Markdown format.
  • content.config.ts: Configuration file for content collections.
  • icons: Contains SVG icon files used in the project.
  • layouts: Contains layout components.
    • BlogPost.astro: Layout component for blog posts.
  • pages: Contains the main pages of the site.
    • blog/index.astro: Blog index page.
    • blog/[...slug].astro: Dynamic route for individual blog posts.
  • styles: Contains global and component-specific CSS files.
    • global.css: Global styles for the project.
    • hamburgers.css: Styles for the hamburger menu.

This structure helps in organizing the project files and makes it easier to maintain and scale the project.

🚀 Getting Started

To run this project locally:

  1. Clone the repository:

    git clone https://github.com/jramma/sorollaportfolio.git
    cd sorollaportfolio
  2. Install dependencies:

    bun install
  3. Start the development server:

    bun dev

    The application will be available at http://localhost:4321.

🛠️ Technologies Used

  • Astro: A modern static site builder.
  • Tailwind CSS: A utility-first CSS framework.
  • TypeScript: A statically typed programming language.

📄 License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages