Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sieep-coding/sieep-coding.github.io

My porfolio/blog built with Astro + TypeScript.
https://github.com/sieep-coding/sieep-coding.github.io

astro astrojs blog markdown nodejs personal-website portfolio portfolio-website template template-project typescript vercel vercel-deployment

Last synced: 10 days ago
JSON representation

My porfolio/blog built with Astro + TypeScript.

Awesome Lists containing this project

README

        

![sieep-coding.github.io](https://socialify.git.ci/sieep-coding/sieep-coding.github.io/image?description=1&font=Bitter&language=1&name=1&owner=1&pattern=Charlie%20Brown&stargazers=1&theme=Dark)

# Interactive Resume & Blog Built With Astro

![Vercel](https://vercelbadge.vercel.app/api/sieep-coding/sieep-coding.github.io) ![License: UNLICENSE](https://img.shields.io/badge/License-UNLICENSE-blue.svg)

Learn more about me and my experience.

View my [blog](https://nickstambaugh.vercel.app/posts/).

## Features :open_hands:

- Dark mode toggle
- Responsive design
- Easy to customize and extend personal data
- Fuzzy search for blog posts
- SEO friendly (robots.txt, sitemap.xml)
- RSS feed

## How to use this template :toolbox:

Note: this mini-guide assumes you have `npm` installed on your machine, if you don't, you can download it following the instructions [here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

1. Click on the "Use this template" button at the top of the repository.
2. Create a new repository based on this template.
3. Clone the repository to your local machine.
4. Install the dependencies by running `npm install`
5. You can now start the development server by running `npm run dev` (see this [section](#16-commands-genie_man) for more commands)
6. Now you can start customizing the portfolio template by updating the `/data/info.ts` file with your personal information.

### Notes about the contact section :email:

If you add/remove something from the contact section in the `info.ts` file, you will need to update the `Contact.tsx` file located in the `src/components/contact_section` directory by simply reflecting the changes you made in the `info.ts` file. Although, this choice may seem redundant, it allows to separate the data from the view.

## Commands :genie_man:

All commands are run from the root of the project, from a terminal:

| 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 |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |

## Tools Used :hammer_and_wrench:

This portfolio template uses the following tools/libraries/resources:

- [Astro](https://astro.build/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Font Awesome](https://fontawesome.com/)
- [React](https://reactjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [Fuse.js](https://fusejs.io/)

## Contributing :building_construction:

If you would like to contribute to the Astro Portfolio Template, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your forked repository.
5. Submit a pull request to the main repository.

See the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.

## About this Astro Template

I created this theme from [gio-del](https://github.com/gio-del/Astro-Theme-Astroway).

# Please leave a star if you enjoyed this template. ⭐