https://github.com/silverlightning926/portfolio

My Portfolio Site - Built In Svelte
https://github.com/silverlightning926/portfolio

Last synced: 3 months ago
JSON representation

My Portfolio Site - Built In Svelte

• Host: GitHub
• URL: https://github.com/silverlightning926/portfolio
• Owner: silverlightning926
• License: mit
• Created: 2024-08-15T17:46:14.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-10-02T04:56:08.000Z (8 months ago)
• Last Synced: 2024-12-30T09:19:47.346Z (5 months ago)
• Language: Svelte
• Homepage: https://www.siddharthrao.info
• Size: 467 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Portfolio

*
By Siddharth Rao
*


---

![Svelte](https://img.shields.io/badge/Svelte-%23FF3E00.svg?style=flat&logo=svelte&logoColor=white) ![Tailwind](https://img.shields.io/badge/Tailwind_CSS-%2306B6D4.svg?style=flat&logo=tailwindcss&logoColor=white) ![GitHub Pages](https://img.shields.io/badge/GitHub_Pages-%23222222.svg?style=flat&logo=amazon-web-services&logoColor=white) ![AWS](https://img.shields.io/badge/AWS-%23FF9900.svg?style=flat&logo=amazon-web-services&logoColor=white)

---

![Deploy](https://github.com/silverlightning926/portfolio/actions/workflows/deploy.yml/badge.svg) ![Formatting](https://github.com/silverlightning926/portfolio/actions/workflows/formatting.yml/badge.svg)

---

- [Portfolio](#portfolio)

  - [Link](#link)

  - [About](#about)

  - [Getting Started](#getting-started)

    - [Local Development](#local-development)

    - [Docker](#docker)

  - [Formatting With Prettier](#formatting-with-prettier)

  - [License](#license)

---

## Link

[siddharthrao.info](https://www.siddharthrao.info)

## About

This is my personal portfolio website. It is built using Svelte and Tailwind CSS. The website is being hosted by Github Pages and is being routed too by AWS Route53.

The website is automatically deployed using GitHub Actions. The website is automatically formatted using Prettier.

## Getting Started

To get a local copy up and running follow these simple steps.

### Local Development

1. Clone the repository:

    ```bash

    git clone 

    ```

2. Install the dependencies:

    ```bash

    npm install --include=dev

    ```

3. Start the development server:

    ```bash

    npm run dev

    ```

4. Open the website in a browser:

    ```bash

    http://localhost:5173

    ```

### Docker

1. Build the Docker image:

    ```bash

    docker build -t portfolio .

    ```

2. Run the Docker container:

    ```bash

    docker run -p 5173:80 portfolio

    ```

3. Open the website in a browser:

    ```bash

    http://localhost:5173

    ```

## Formatting With Prettier

The website is automatically formatted using Prettier. The configuration for Prettier is stored in the `.prettierrc` file.

To format the website manually, run the following command:

```bash

npm run format

```

To check if the website is formatted correctly, run the following command:

```bash

npm run format:check

```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.