diff --git a/README.md b/README.md index 28bc61c..3bf8854 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,63 @@ +# 🌌 Milky-Way +This is a portfolio template built using CSS, HTML, JavaScript, and Astro. It serves as a starting point for creating your personal portfolio website or showcasing your projects online. The template is open-source and released under the MIT license, meaning you are free to use, modify, and distribute it for personal or commercial purposes. +

- Astro + Astro

[![Netlify Status](https://api.netlify.com/api/v1/badges/0b0bcb79-a1d8-4b32-9566-8f30af19e4cc/deploy-status)](https://app.netlify.com/sites/astro-milky-way/deploys) -# Milky-Way - -This is a portfolio template built using CSS, HTML, JavaScript, and Astro. It serves as a starting point for creating your personal portfolio website or showcasing your projects online. The template is open-source and released under the MIT license, meaning you are free to use, modify, and distribute it for personal or commercial purposes. - -### Lighthouse Score: -Lighthouse Score +## 🔥 Features +- [x] Simple and clean design, perfect for showcasing your work. +- [x] Responsive layout for seamless viewing across different devices. +- [x] Fast and efficient, thanks to the Astro static site generator. +- [x] Easy to customize with CSS and straightforward HTML structure. -## Features - -- Simple and clean design, perfect for showcasing your work. -- Responsive layout for seamless viewing across different devices. -- Fast and efficient, thanks to the Astro static site generator. -- Easy to customize with CSS and straightforward HTML structure. - -## Getting Started - -To get started with using this portfolio template, follow these steps: +## ⚓ Lighthouse Score +

+ Lighthouse Score +

-1. **Clone the Repository:** Clone this repository to your local machine using Git. +## 🚀 Getting Started +Clone this repository to your local machine using Git. ```scheme git clone https://github.com/ttomczak3/Milky-Way.git cd Milky-Way ``` -2. **Install Dependencies:** Ensure you have Node.js and npm installed. Then, install the project dependencies. -```scheme -npm install -``` +| Command | Action | +| :---------------- | :------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:4321` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | -3. **Start the Development Server:** Launch the development server to preview your portfolio. +Edit the HTML files in the `src/pages` directory to add your projects, experiences, and personal information. You can also modify the CSS styles in `src/styles` to match your preferences. -```scheme -npm run dev -``` +## 📂 Project Structure -4. **Customize Your Portfolio:** Edit the HTML files in the `src/pages` directory to add your projects, experiences, and personal information. You can also modify the CSS styles in `src/styles` to match your preferences. - -## Contributing +``` +/ +├── public/ +│ └── blog.png +│ └── blog.webp +│ └── favicon.svg +│ └── GitHub.webp +│ └── laptop.webp +│ └── space.webp +│ └── youtube.png +├── src/ +│ ├── components/ +│ ├── layouts/ +│ └── pages/ +│ └── styles/ +│ └── env.d.ts +└── package.json +``` +## 💻 Contributing Contributions to this project are welcome. If you find a bug or have a suggestion for improvement, please open an issue or submit a pull request. -## License - +## 📃 License This project is licensed under the MIT License. See the `LICENSE` file for details. diff --git a/milkyway-lighthouse-score.svg b/milkyway-lighthouse-score.svg new file mode 100644 index 0000000..db86b3d --- /dev/null +++ b/milkyway-lighthouse-score.svg @@ -0,0 +1,159 @@ + + + + + + 100 + Performance + , + + + 100 + Accessibility + , + + + 100 + Best Practices + , + + + 100 + SEO + + + + + + + + + + + + + + 0-49 + 50-89 + 90-100 + + + \ No newline at end of file