7cc5c4f330d47060/tiktok-sparo
1
0
Fork 0
mirror of https://github.com/tiktok/sparo.git synced 2024-11-27 01:26:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
tiktok-sparo/apps/website/README.md
Pete Gonzalez 8ccf90bcca Update project README.md
2024-02-21 23:48:30 -08:00

1 KiB
Raw Blame History

Website

This is the Docusaurus project for the Sparo website.

Development

  1. Install the monorepo dependencies using RushJS:

    rush install
rush build

  2. Launch the local development server:

    cd apps/website
rushx start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Deployment

  1. If you will manually copy the files to a server, you can build the apps/sparo/build folder like this:

    cd apps/website
rushx build

  2. To automatically deploy to GitHub Pages (as an administrator):

    # If you are using HTTPS authentication for GitHub:
cd apps/website
GIT_USER=<Your GitHub username> rushx deploy

    # If you are using SSH authentication for GitHub:
USE_SSH=true rushx deploy

See also