CodinCod project overview

The docs repo exists to:

1. get up to speed quickly;
2. create a general shared understanding;
3. improve teamwork.

Getting started

1. Required software:

   • Git
   • NodeJs
   • Pnpm
   • MongoDb instance: can be either locally or in mongodb's online environment.
   • Piston, used for code execution in a safe environment, if you are not going to execute code, you don't technically need it

2. Clone the project structure and its submodules:

   git clone https://github.com/JuiceMitApfelnDrin/CodinCod

3. Build the types (required by both libs/backend and libs/frontend)

   cd CodinCod/libs/types
   pnpm install
   pnpm build

4. Follow the instructions for the backend and/or frontend depending on what you're working on