codebattle

# Codebattle

[![Actions Status](https://github.com/hexlet-codebattle/codebattle/workflows/Build%20master/badge.svg)](https://github.com/hexlet-codebattle/codebattle/actions)
[![codecov](https://codecov.io/gh/hexlet-codebattle/codebattle/branch/master/graph/badge.svg)](https://codecov.io/gh/hexlet-codebattle/codebattle)

Codebattle - is an open source game being developed by the Hexlet community.
The current version of the application is available at [codebattle.hexlet.io](https://codebattle.hexlet.io).

This project exists thanks to all the people who contribute. [Contribute guideline.](CONTRIBUTING.md)

<a href="https://github.com/hexlet-codebattle/codebattle/graphs/contributors"><img src="https://opencollective.com/codebattle/contributors.svg?width=890"></a>

![Alt](https://repobeats.axiom.co/api/embed/cb0f9e443414905bb8a0e437460095b05bc11caf.svg "Repobeats analytics image")

### Requirements

- Mac / Linux
- Docker
- Optional: an editor that supports the [Dev Container specification](https://containers.dev/)

### Install

```bash
git clone git@github.com:hexlet-codebattle/codebattle.git
cd codebattle
make setup
```

`make setup` builds the pinned development image, installs Elixir and frontend
dependencies inside it, starts PostgreSQL, and prepares the database. Host
installations of Elixir, Erlang, Node.js, pnpm, and Go are not used.

To work from an editor, open the repository and choose **Reopen in Container**.
The same Make commands work in a host terminal and in the container terminal.

### Start Server

```bash
make server
```

- Open <http://localhost:4000>

### Run Tests

```bash
make test
make test-fe
```

### Lint

```bash
make lint
make credo
make check-js

# To run specific
make format
make lint-js-fix
```

### Useful

```bash
make console
make dev-shell
make dev-exec CMD='mix upload_langs'

make db-migrate
make dev-rebuild
make dev-down
make clean # Removes the development containers and their persistent volumes
```

All application commands run in the non-root development container. The source
tree is the only host directory mounted into it; dependency caches and database
data use Docker-managed volumes. Host Docker/Podman sockets and host credential
directories are intentionally not mounted.

The repository is writable inside the container, so keep only disposable
development credentials in `.env`. Never put production or personal cloud
credentials in the workspace. The host `.env` is masked in the container and
only the variables explicitly allowlisted in `compose.yml` are passed through.

Runner image build and publish targets still execute through the host container
engine because they orchestrate other containers. Treat those targets as
privileged operations and use them only with trusted code.

Codebattle is a single Phoenix app: `lib/`, `test/`, `priv/`, `frontend/`, and
`static/` live at the repository root. Shared language and checker code lives in
`lib/codebattle/runner/`; language image sources live in `images/`.

Sol