PDKit - The Project Development Kit
A construct driven approach to project and repository management.
Table of Contents
About The Project
PDKit, or the Project Development Kit, is a new way of managing your projects using code. Based on the idea of constructs, PDKit allows you to manage single or monorepos through code.
This project is still in early alpha and not yet available via typical distribution methods (ie. npm). My intention is to first fully support the needs of this project prior to general availability.
Goals
The PDKit project has several key goals it intends to keep:
- Highly Configurable
- Highly Extendable
- Concentrate on the NodeJS ecosystem, but build with compatibility for more in mind
- Community Driven
Built With
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
Getting Started
** This is ALPHA software, use at your own risk! **
Installation
- Install PDKit packages
npm install @pdkit/cli
Usage
We eat our own dogfood, check out our .pdkitrc.ts for an idea on how to get started. We use Typescript to help ensure optimum IDE support.
** This is ALPHA software, use at your own risk! **
Documentation
Additional documentation is available at ./docs.
Roadmap
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
See also: Contributing Guidelines
License
Distributed under the Apache 2.0 License. See LICENSE for more information.
Contact
Justin McCormick - @justinm - me@justinmccormick.com
Project Link: https://github.com/justinm/pdkit
Acknowledgments
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!