Skip to content

cs-magic/codebase-ts

Repository files navigation

CS Magic Banner

CS Magic TypeScript Codebase

Preparation

  • configure env (refer to env.sample
  • configure dependencies:
packages=(
 jq go # for wechaty-puppet
 bash  # for `shopt -s globstar` since the default base is too old on Mac
 nvm   # for configuring node/npm/yarn
 postgresql # brew services start postgresql, and install nanoid, pgvectors, see in scripts/post-install.sh
 redis # brew services start redis
)
brew install "${packages[@]}"
  • prepare yarn: NV=18.19.0 && nvm install $NV && nvm use $NV && npm i -g yarn
  • export PATH=$(pwd)/node_modules/.bin:$PATH (sometimes important!)
  • installation: yarn (db migration will auto exec)
  • yarn workspaces foreach -pA add -D npm-run-all
    yarn workspaces foreach -pA --include "packages/frontend/*" --include "packages/backend/*" add -D ts-patch typescript-transform-paths  
    

References

Upstreams

We would also like to give thanks to open-source projects that make CS-Magic possible:

  • ReactJS - The library for web and native user interfaces.
  • NextJS - The React Framework for the Web.
  • Vite - Next generation frontend tooling.
  • ElectronJS - Build cross-platform desktop apps with JavaScript, HTML, and CSS.
  • Jotai - Primitive and flexible state management for React.
  • Other upstream dependencies.

Thanks a lot to the community for providing such powerful and simple libraries, so that we can focus more on the implementation of the product logic, and we hope that in the future our projects will also provide a more easy-to-use knowledge base for everyone.

Authors