Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/yuneg11/yuneg11.github.io

Personal website
https://github.com/yuneg11/yuneg11.github.io

svelte

Last synced: 9 days ago
JSON representation

Personal website

Awesome Lists containing this project

README

        

# yuneg11.github.io

This project is based on [SAPPER](https://sapper.svelte.dev), [Bootstrap](https://getbootstrap.com), and [rollup.js](https://rollupjs.org/guide/en/).

## Setup

### Local

```bash
npm install
npm run init
npm run keygen
```

### GitHub

[Reference](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-create-ssh-deploy-key)

Go to Repository Settings

- Go to **Deploy Keys** and add your public key (`gh-pages.pub`) with the **Allow write access** as **Deploy key**
- Go to **Secrets** and add your private key (`gh-pages`) as **DEPLOY_KEY**

## Run development server

```bash
npm run dev
```

## Export static page

```
npm run export
```

Note that `301` on `index.html` and `404` on `404/index.html` are expected.

To test the exported site,

```
npm run serve
```

## Lint

```bash
npm run lint
```

Please try to keep code conventions.

## Deploy

*Do not deploy to public repository. If you want to test deployment, use your own repository.*

```bash
npm run deploy
```

## Project Structure

```bash
root
├ data
├ src
│ ├ components # Individual components
│ ├ routes # Pages of website (home, people, etc..)
│ ├ styles # SCSS files (You may not need to change it)
│ ├ client.js # Sapper related file (You may not need to change it)
│ ├ server.js # Sapper related file (You may not need to change it)
│ └ template.html # Template of all pages
├ static # Static files
├ .eslintignore # ESLint related file
├ .eslintrc.js # ESLint config file
├ .gitignore # GIT related file
├ package-lock.json # NPM related file
├ package.json # NPM related file
├ rollup.config.js # Rollup config file
└ svelte.config.js # Svelte config file for VSCode
```

The majority of time, you may work with `components` and `routes`.