Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.18 KB

Thank you for your interest in contributing to this project! If you are new to contributing to open source, please read the How to Contribute to Open Source guide.

If you would like to make changes to the source, feel free to submit a PR!

Getting Started

This project is a monorepo managed with Yarn workspaces.

You can find all the FireCMS packages in the packages folder. The code that simulates a final project implemented by a user can be found in the examples folder.

All dependencies are linked automatically and just running the following commands should be enough to get you started.

After pulling the code you just need to run:

yarn
yarn dev

to start the demo project.

You can also run:

yarn
yarn pro

to use the example project with the Pro version of FireCMS.

Support and discussion

Please join our Discord channel to discuss any details regarding adaptations. We are happy to help!

You are encouraged to check with us before implementing any major changes to the library, that would like to be submitted as a PR.