base on SDK & API Docs Generator. Sunset as of December 2024 # Konfig The monorepo that holds everything... ## Getting started Get the repository on your local machine. **Takes a minute.** ```shell git clone https://github.com/konfig-dev/konfig --recursive cd konfig ``` This repository has submodules so pull all of them. **Also take a few minutes.** ```shell git submodule update --init --recursive --remote --merge ``` ## Environment Setup 1. Run Postgres as a background process ```shell # in /konfig brew install postgresql mkdir -p postgres/data initdb -D ./postgres/data pg_ctl -D ./postgres/data start ``` 1. Setup `.env` file in `generator/konfig-dash` to something like: ``` DATABASE_URL="postgresql://dylanhuang@localhost:5432/konfig_dev?connection_limit=1" TEST_DATABASE_URL="postgresql://dylanhuang@localhost:5432/konfig_test?connection_limit=1" AWS_ACCESS_KEY_ID=XXXXXX AWS_SECRET_ACCESS_KEY=XXXXXX # Used to encrypt/decrypt session cookies. Change this value and re-deploy to log out all users of your app at once. SESSION_SECRET=ZUWpQ9pB4fB5FFpjHLi8Z2qadzXkdTKhHBsXmGmjNdxtrZbevaCYWSpw7G7cHBhh ``` Paste this into your `~/.zshrc` or `~/.bashrc` ```bash if [ -f $HOME/.envvars ]; then . $HOME/.envvars else print "404: ~/.envvars not found." fi ``` Then create `~/.envvars` with values from Dylan. ## How to run Konfig 1. Make sure `node_modules` is initiated in `konfig-dash` ```shell cd generator/konfig-dash yarn # takes some time yarn rw prisma migrate dev # setup the DB ``` 1. Start the server with `yarn dev` ```shell # inside generator/konfig-dash yarn dev ``` 1. Start `generator/konfig-generator-api` w/ IntelliJ 1. `cd` into an SDK repo and run `konfig generate -d` ## Making Changes See [Changesets](https://github.com/changesets/changesets) ", Assign "at most 3 tags" to the expected json: {"id":"12501","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"