Skip to content

Commit

Permalink
update README to remove reference to dev script -- simply using vit…
Browse files Browse the repository at this point in the history
…e preview via npm start now for stricter dev environment. user can still use vite dev and supply their own watch scripts if they desire
  • Loading branch information
jimmy-zhening-luo committed Aug 5, 2024
1 parent 0c82e7c commit 241accd
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,10 @@ This repository contains Jimmy Luo's personal website. As of August 31, 2022, th

<details>
<summary>Dev Tools</summary>

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.
- __[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.

Expand Down Expand Up @@ -42,8 +41,7 @@ The source contained in this repository's `main` branch is continuously built an

</details>

<br/>
<br/>
<br />

## Build, test, and deploy this app

Expand All @@ -56,13 +54,15 @@ The source contained in this repository's `main` branch is continuously built an

1. If you don't already have Node.js, [install Node.js](https://nodejs.org).

2. Save this Git repository on your local machine.
1. Save this Git repository on your local machine.

3. Open a terminal at the root of the repository.
1. 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):
1. Run the following command to install all the required Node.js packages (specified in your project root directory by package.json):

npm ci
```bash
npm ci
```

You now have:

Expand All @@ -74,15 +74,18 @@ You now have:
<br/>

<details>
<summary>Step 2: Build and run the web app.</summary>
<summary>Step 2: Build and locally preview the web app.</summary>

You can now preview what the website will look like once built and deployed, by running the following command:

You can now run this web app's `dev` script, which uses Vite to build a local (unoptimized) static web app bundle and serve the built bundle from your local host machine. It also continuously rebuilds when any code changes are detected, so you can see your changes in real-time.
```bash
npm start
```

npm run dev
If you make changes to the site code, you need to run `npm start` again.

</details>

<br/>
<br/>

### Deploying to production
Expand Down

0 comments on commit 241accd

Please sign in to comment.