Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/resource-watch/vizz-wysiwyg

Check the documentation here
https://github.com/resource-watch/vizz-wysiwyg

wysiwyg

Last synced: 1 day ago
JSON representation

Check the documentation here

Awesome Lists containing this project

README

        

# Wysiswyg
Welcome to the most amazing Wysiwyg.

## Documentation
Check [the docs](https://resource-watch.github.io/vizz-wysiwyg/styleguide/)

## Dependencies
yarn add [email protected]
yarn add [email protected]

## Peer dependencies
yarn add [email protected]

## Running locally in development mode
To get started in development mode, just clone the repository and run:

yarn install
yarn run dev

## Linking into another project
If you want to debug the Wysiwyg within another project, please execute the following in the main directory:

yarn link
yarn run component

In your other project, run this:

yarn link "@vizzuality/wysiwyg"

Every change in the Wysiwyg's codebase will be reflected in your other project (might need a page reload). The Wysiwyg will also be built using the development environment so it's easier to debug.

## Building and deploying in production
If you wanted to run this site in production run:

yarn install
yarn run build
yarn start

You should run the the build step again any time you make changes to pages or
components.

## Publishing
- component: `yarn run publish`
- documentation: `yarn run documentation`
- staging: `git push heroku master`