Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to build/contribute/develop instructions would be nice #44

Open
ryanackley opened this issue Jan 16, 2019 · 1 comment
Open

How to build/contribute/develop instructions would be nice #44

ryanackley opened this issue Jan 16, 2019 · 1 comment

Comments

@ryanackley
Copy link

I'm wondering how you work on the example app since all of the packages are linked through npm rather than the local file system. I'm guessing you don't deploy to npm each time you update a local dependency (i.e. formbuilder).

At first glance, I was thinking I could simply point package.json to the local dependencies but it's not clear how to get all of the devtools dependencies (flow, webpack, etc. ) to listen for file changes in all relevant directories.

I'm hoping for guidance on how you develop this app and instructions for me to set up in an identical manner.

@draperd
Copy link
Owner

draperd commented Jan 16, 2019

Thanks for showing an interest in this project and getting in touch.

The project is set up to use Lerna (https://github.com/lerna/lerna) which you will need to install globally to build all the projects at once. I've used this approach so that I can publish the packages individually (because I wanted to keep the size of the core package to a minimum based on the logic that people would probably want to write their own renderer packages and I didn't want to bundle Atlaskit and/or Material UI with the core package).

Lerna allows me to easily build all the packages at once and publish easily. Typically when I've been developing I usually take a TDD approach and try to do as much development just against the unit tests.

If I have the example app running then updates I make by building the other packages will automatically get picked up by the hot reloader.

To be perfectly honest I'm not entirely satisfied with the approach to development because I'd like the example app to hot reload without me needing to build the other packages but I haven't had the time to invest in setting that up yet.

I know that I could do with updating the documentation to make development easier but I haven't had a lot of free time to devote to that recently.

I hope this helps!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants