Skip to content

Latest commit

 

History

History
198 lines (137 loc) · 6.38 KB

README.md

File metadata and controls

198 lines (137 loc) · 6.38 KB
Raw

Contributors Forks Stargazers Issues MIT License


PDKit - The Project Development Kit

A construct driven approach to project and repository management.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Documentation
  5. Roadmap
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgments

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.

(back to top)

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.

(back to top)

Getting Started

** This is ALPHA software, use at your own risk! **

Installation

  1. Install PDKit packages 
    npm install @pdkit/cli

(back to top)

Usage

We eat our own dogfood, check out our .pdkitrc 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! **

(back to top)

Documentation

Additional documentation is available at ./docs.

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

See also: Contributing Guidelines

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

(back to top)

Contact

Justin McCormick - @justinm - me@justinmccormick.com

Project Link: https://github.com/justinm/pdkit

(back to top)

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!

(back to top)