ALYS/alys.phundrak.com
1
0
Fork 0
Code Issues Pull Requests Actions Activity

docs(README): Update README
All checks were successful
Deploy website to alys.phundrak.com / build (push) Successful in 20s
Details

Browse Source
This commit is contained in:
Lucien Cartier-Tilet 2024-06-28 06:15:05 +02:00
parent e3f21a252b
commit 2b00f590c3
Signed by: phundrak
GPG Key ID: BD7789E705CB8DCA
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,19 +1,22 @@
# ALYS Vocal Libraries Website # ALYS Vocal Libraries Website
## Installing dependencies ## Installing dependencies
To run the website, you will need corepack’s yarn 4. You can enable it To run the website, you will need the NPM package manager. You can
using `yarn set version stable`, or you can enter a Nix shell using either install it following your operating system’s workflow, or you
`nix-shell` at the root of this repository. can enter a Nix shell using `nix-shell` at the root of this
repository. If you run `direnv allow .` at the root of this
repository, the Nix shell made for this project will be loaded
automatically.
To install all dependencies, run the following command: To install all dependencies, run the following command:
```sh ```sh
yarn npm install
``` ```
## Running the website ## Running the website
To run the website in development mode, run the following command: To run the website in development mode, run the following command:
```sh ```sh
yarn dev npm run dev
``` ```
This will start the website at <http://localhost:5173>. This will start the website at <http://localhost:5173>.
@ -21,12 +24,12 @@ This will start the website at <http://localhost:5173>.
## Building the website ## Building the website
To build the website, run the following command: To build the website, run the following command:
```sh ```sh
yarn build npm run build
``` ```
You can view this release build by running the following command: You can view this release build by running the following command:
```sh ```sh
yarn preview npm run preview
``` ```
# License # License