Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimmy-zhening-luo/jimmy
This repository contains Jimmy Luo's personal website. As of August 31, 2022, the main branch of this repository is continuously deployed to https://jimm.my.
https://github.com/jimmy-zhening-luo/jimmy
azure-static-web-apps sveltekit typescript
Last synced: about 2 months ago
JSON representation
This repository contains Jimmy Luo's personal website. As of August 31, 2022, the main branch of this repository is continuously deployed to https://jimm.my.
- Host: GitHub
- URL: https://github.com/jimmy-zhening-luo/jimmy
- Owner: jimmy-zhening-luo
- License: mit
- Created: 2022-08-28T06:23:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T21:53:12.000Z (2 months ago)
- Last Synced: 2024-10-24T16:54:01.415Z (2 months ago)
- Topics: azure-static-web-apps, sveltekit, typescript
- Language: Svelte
- Homepage: https://jimm.my
- Size: 1.7 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# [jimm.my](https://jimm.my/)
[](https://github.com/jimmy-zhening-luo/jimmy/actions/workflows/PROD.main.yml)
## What am I?
This repository contains Jimmy Luo's personal website. As of August 31, 2022, the `main` branch of this repository is continuously deployed to [jimm.my](https://jimm.my/).
Dev Tools
This is a static web app built on [Node.js](https://nodejs.org/en/) using [SvelteKit](https://kit.svelte.dev), a helper that bundles [Svelte](https://svelte.dev/) and [Vite](https://vitejs.dev).
- __[Svelte](https://svelte.dev/)__ enables concise, descriptive, and modular syntax for site content, routing, style, and logic.
- __[Vite](https://vitejs.dev)__ provides a self-contained, minimal-config test and build environment, capable of adapting Svelte code into a compact servable static bundle.
The source is written in [TypeScript](https://typescriptlang.org/) and Svelte.
| Key | Value |
| ------------ | ---------------------------------------------------- |
| Platform | Windows 11 |
| Architecture | amd64 |
| IDE | [Visual Studio Code](https://code.visualstudio.com/) |
| Dependencies | See `package.json` |
Deployment Infra
The source contained in this repository's `main` branch is continuously built and deployed to an [Azure Static Web App](https://azure.microsoft.com/en-us/products/app-service/static) instance using [GitHub Actions](https://github.com/features/actions).
| Key | Value |
| ---------------------- | -------------------------------------------------------------------------------------------------------- |
| Cloud Service Provider | Microsoft Azure |
| Cloud App | [Azure Static Web App](https://azure.microsoft.com/en-us/products/app-service/static) |
| CI/CD Connector | [GitHub Actions](https://github.com/features/actions) |
## Build, test, and deploy this app
### Local testing
Step 1: Prepare your development environment.
1. If you don't already have Node.js, [install Node.js](https://nodejs.org).
2. Save this Git repository on your local machine.
3. Open a terminal at the root of the repository.
4. Run the following command to install all the required Node.js packages (specified in your project root directory by package.json):
```bash
npm ci
```
You now have:
- ... all the necessary project files downloaded to your local directory.
- ... all the necessary dependencies installed to locally build and deploy (test) this web app.
Step 2: Build and locally preview the web app.
You can now preview what the website will look like once built and deployed, by running the following command:
```bash
npm start
```
If you make changes to the site code, you need to run `npm start` again.
### Deploying to production
TBD
TBD some point in the future.