Quickstart

Clone the repository

1. Set up your GitHub account and configure SSH access.
2. Clone the repository to your local machine. Example: git clone git@github.com:Novators-kz/april-docs.git.
3. If there is a proper README, do what’s there and skip to Configure your IDE.

For Python developers

Using mise and uv (recommended)

1. Install mise
2. Install uv
3. uv sync --group dev – sets up the virtual environment with packages, including packages for testing
4. mise run dev – executes the dev task specified in the repository

Using venv and pip

1. Create a virtual environment: python -m venv .venv.

2. Activate the virtual environment:

   • Windows: .venv\Scripts\activate
   • macOS/Linux: source .venv/bin/activate

3. Install required packages: pip install -r requirements.txt.

4. On every subsequent working session, activate the environment.

Configure your IDE

VS Code / VS Codium

1. Create a new profile (recommended):

   • Open VS Code and press Ctrl+Shift+P (or Cmd+Shift+P on macOS).
   • Select “Profiles: New Profile”, name it (e.g., April), and confirm.
   • From now on, install extensions in this profile.
   • Set correct profiles for our projects with the “Profiles: Switch Profile” command.

2. Install extensions:

   • Svelte:
     • Svelte for VS Code
     • Tailwind CSS IntelliSense
     • Prettier
   • Python:
     • ty
     • Ruff
   • Other to consider:
     • Project Manager
     • GitHub Pull Requests
     • Auto Rename Tag
     • autoDocstring (Python)
     • Image Preview

3. Update settings.json for the User or Workspace:

   {
     "python.languageServer": "ty",
     "[python]": {
       "editor.defaultFormatter": "charliermarsh.ruff",
       "editor.formatOnSave": true
     },
     "[typescript]": {
       "editor.defaultFormatter": "esbenp.prettier-vscode"
     },
     "[svelte]": {
       "editor.defaultFormatter": "svelte.svelte-vscode"
     },
     "[markdown]": {
       "editor.defaultFormatter": "esbenp.prettier-vscode"
     },
     "[html]": {
       "editor.defaultFormatter": "esbenp.prettier-vscode"
     },
     "[yaml]": {
       "editor.defaultFormatter": "esbenp.prettier-vscode",
       "editor.autoIndent": "advanced",
       "diffEditor.ignoreTrimWhitespace": false,
       "editor.quickSuggestions": {
         "strings": "on"
       }
     },
     "[dockercompose]": {
       "editor.defaultFormatter": "docker.docker"
     },
     "svelte.enable-ts-plugin": true,
     "typescript.inlayHints.enumMemberValues.enabled": true,
     "typescript.format.semicolons": "insert"
   }

Other IDEs

TODO.