Few lines describing your project.
📝 Table of Contents
- About
- Getting Started
- Deployment
- Usage
- Built Using
- Contributing
- Authors
- Acknowledgments
- Contributors
🧐 About
Write about 1-2 paragraphs describing the purpose of your project.
🏁 Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
Node version as shown in /package.json
Installing
git clone https://github.com/elmpp/peartree && cd peartree && yarn bootstrap
You can then run the project with:
yarn dev
🔧 Running the tests
yarn test
💋 Code Style
Formatting project:
yarn format
Linting project:
yarn lint
🎈 Usage
Add notes about how to use the system.
⛏️ Built Using
- MongoDB - Database
✍️ Authors
- @elmpp - Idea & Initial work
🎉 Acknowledgements
- Hat tip to anyone whose code was used
👏 Contributors
 elmpp |