Reactive Manual
Data-driven components for building Maps and Search UIs
Reactive Manual contains the docs for all the Reactive components from appbase.io including ReactiveSearch and ReactiveMaps.
Contributing
Prerequisites
- Git
- Node: install version 8.4 or greater
- Yarn: See Yarn website for installation instructions
- A clone of the repo on your local machine
- A fork of the repo (for any contributions)
Installation
cd reactive-manual
to go into the project rootyarn
to install the website's npm dependencies
Running locally
yarn dev
to start the hot-reloading development server (powered by Gatsby)open http://localhost:8000
to open the site in your favorite browser
Contributing
Create a branch
git checkout master
from any folder in your localreactive-manual
repositorygit pull origin master
to ensure you have the latest main codegit checkout -b my-awesome-branch
(replacingmy-awesome-branch
with a suitable name) to create a branch
Make the change
- Follow the "Running locally" instructions
- Save the files and check in the browser
- Changes to React components in
src
will hot-reload - Changes to markdown files in
content
will hot-reload - If working with plugins, you may need to remove the
.cache
directory and restart the server
Tips
- For highlighting specific section of a code use the following format ```js{8-11}
Test the change
- If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
- Run
yarn check-all
from the project root. (This will run Prettier, ESLint, and Flow.)
Push it
git add -A && git commit -m "My awesome message"
(replacingMy awesome message
with a commit message, such asFixed a really awesome bug with UI
) to stage and commit your changesgit push my-fork my-awesome-branch
- Go to the repo and you should see recently pushed branches.
- Follow GitHub's instructions.
Troubleshooting
yarn reset
to clear the local cache