Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1005 Bytes

README.md

File metadata and controls

45 lines (28 loc) · 1005 Bytes

Praise

This repository contains the landing page and docs for Praise - the rewards system allowing communities to acknowledge community contributions, building a culture of giving and gratitude.

Find the website here: https://givepraise.xyz

The Praise docs website is built using Docusaurus 2.

Installation

$ yarn

Local Development

$ yarn 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.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.