Skip to content

fix: update README #698

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: update README #698

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 16 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,28 @@ A [Nuxt](https://nuxtjs.org/) powered frontend website for the UCLA Library.

<details><summary>SET UP THE NUXT SITE</summary>

**This is a Nuxt site, it builds and deploys like any other Nuxt project.**

Works best with the [fuxt-backend](https://github.com/funkhaus/fuxt-backend) WordPress theme as the backend.

**First step:** Duplicate and rename `.example.env` to `.env`. Define any vars environment needed there.
1. Duplicate and rename `.example.env` to `.env`. Define any vars environment needed there.
Be sure to do this before running `npm install`

```bash
# install dependencies
$ npm install
2. install dependencies
$ `npm install`

# serve with hot reload at localhost:3000
$ npm run dev
3. serve with hot reload at localhost:3000
$ `npm run dev`

# serve with hot reload Storybook at localhost:3003
$ npm run storybook
4. serve with hot reload Storybook at localhost:3003
$ `npm run storybook`

# build for production and launch server
### Build for production and launch server
$ npm run build
$ npm start
$ `npm start`

# build Storybook for production
$ npx nuxt storybook build

# generate static nuxt site
$ npm run generate
### Generate static nuxt site
$ `npm run generate`

**This is a Nuxt site, it builds and deploys like any other Nuxt project.**

(Works best with the [fuxt-backend](https://github.com/funkhaus/fuxt-backend) WordPress theme as the backend.)

```

Expand Down