diff --git a/.gitignore b/.gitignore index e7cafcdce..363d6c49f 100644 --- a/.gitignore +++ b/.gitignore @@ -142,4 +142,5 @@ tmp/ # claude stuff .claude/settings.local.json -docs/plans \ No newline at end of file +docs/plans +.codegraph diff --git a/CREDITS.md b/CREDITS.md index 0b58844ee..66b1a6741 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -488,6 +488,37 @@ SOFTWARE. ------------------------------------------------------------------------------- +## Project +@colbymchenry/codegraph + +### Source +https://github.com/colbymchenry/codegraph + +### License +MIT License + +Copyright (c) 2026 Colby Mchenry + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +------------------------------------------------------------------------------- + ## Project @eddeee888/gcg-typescript-resolver-files diff --git a/README.md b/README.md index 4a5153125..386cc30ec 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,13 @@ Plumber is a no-code solution that helps public officers automate their repetiti ## Local dev 1. Install Docker and make sure it's running -1. Install dependencies by running `npm i` -1. Create a `.env` in `packages/backend` based on `.env-example` -1. Setup services `npm run setup` -1. Run DB migrations `npm run migrate` (only for first time setup) -1. Start the server `npm run dev` +2. Install code dependencies by running `npm i` +3. Install global dependencies: + 1. [Codegraph](https://github.com/colbymchenry/codegraph) +4. Create a `.env` in `packages/backend` based on `.env-example` +5. Setup services `npm run setup` +6. Run DB migrations `npm run migrate` (only for first time setup) +7. Start the server `npm run dev` ## Acknowledgements