Skip to content
This repository has been archived by the owner. It is now read-only.
v3
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Reactive Manual

Note: ReactiveSearch Docs have moved to http://github.com/appbaseio/Docs. Any new PRs should be made over there.

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

  1. Git
  2. Node: install version 8.4 or greater
  3. Yarn: See Yarn website for installation instructions
  4. A clone of the repo on your local machine
  5. A fork of the repo (for any contributions)

Installation

  1. cd reactive-manual to go into the project root
  2. yarn to install the website's npm dependencies

Running locally

  1. yarn dev to start the hot-reloading development server (powered by Gatsby)
  2. open http://localhost:8000 to open the site in your favorite browser

Contributing

Create a branch

  1. git checkout master from any folder in your local reactive-manual repository
  2. git pull origin master to ensure you have the latest main code
  3. git checkout -b my-awesome-branch (replacing my-awesome-branch with a suitable name) to create a branch

Make the change

  1. Follow the "Running locally" instructions
  2. Save the files and check in the browser
  3. Changes to React components in src will hot-reload
  4. Changes to markdown files in content will hot-reload
  5. 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

  1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
  2. Run yarn check-all from the project root. (This will run Prettier, ESLint, and Flow.)

Push it

  1. git add -A && git commit -m "My awesome message" (replacing My awesome message with a commit message, such as Fixed a really awesome bug with UI) to stage and commit your changes
  2. git push my-fork my-awesome-branch
  3. Go to the repo and you should see recently pushed branches.
  4. Follow GitHub's instructions.

Troubleshooting

  • yarn reset to clear the local cache