tenancy-docs/README.md

stancl/tenancy docs

For the main repository, see stancl/tenancy.

Getting started

Prerequisites

1. Git
2. PHP: any 7.x version starting with v7.3 or greater
3. Composer: See Composer Website
4. Node: any 12.x version starting with v12.0.0 or greater
5. A fork of the repo (for any contributions)
6. A clone of tenancy-docs on your local machine

Installation

1. composer install to install dependencies
2. npm install to install the docs npm dependencies

Running locally

1. You can use npm run watch, npm run dev, and npm run production.
2. open http://localhost:3000 to open the site in your favorite browser

Contributing

Create a branch

1. git pull origin master to ensure you have the latest main code
2. git checkout -b the-name-of-my-branch (replacing the-name-of-my-branch with a suitable name) to create a branch

Make the change

Push it

1. git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fix header logo on Android) to stage and commit your changes
2. git push my-fork-name the-name-of-my-branch
3. A Netlify build will also be automatically created once you make your PR so other people can see your change.