Main readme

Author: inkustr

README.md

@@ -1,59 +1,14 @@
 Sheetcode
 ====================
-Sheetcode is a service which allows users to create, edit and solve programming tasks and challange each other.
+ShetCode is a LeetCode-like platform built with Symfony and PostgreSQL. It supports public/private coding problems, sandboxed Python execution, and feedback submission. It is designed as a CTF service with multiple flagstores and intended vulnerabilities.
 -----------------------------------------------
 
-# Usage
+# Installation and Setup
+## Service
+The service is located in the `service` directory.
 
-Use this repository as the base structure for your service. Please keep the directory structure and the following required files:
+## Checker
+The checker is located in the `checker` directory.
 
-- `README.md` with a description of your vulnerabilities and exploits.
-- `LICENSE` with the MIT
-- `.gitignore` files exclude directories or files from being committed.
-- `.dockerignore` files exclude directories or files from being tracked by the docker daemon.
-- `.env` files used by docker-compose to assign a unique project-name.
-- `docker-compose.yml` files to manage your service or checker containers
-- `Dockerfile` with commands to build your service
-
-# Checking your service
-
-You will have to implement a checker script, which periodically interacts with your service to store and retrieve flags and checks if it still behaves correctly. The game engine will call your checker during a CTF. Use the web interface or `enochecker_cli` to call your different checker methods. 
-
-## Manually
-However, you can also perform all game engine call manually in your local development environment. 
-
-- First, start your service with `cd service` and `docker-compose up --build`. 
-- Next, start your checker with `cd checker` and `docker-compose up --build`. 
-
-### Web interface
-The checker launches a web interface on the port configured in its `docker-compose.yml`.
-
-- Browse to `http://localhost:<checker-port>` to reach the checker interface.
-
-### enochecker_cli
-
-Install `enochecker_cli` using `pip install --user enochecker_cli`. Provide the needed checker URL (`http://localhost:8000`), service IP address (i.e. `192.168.2.112`) and the checker methods to call:
-
-```
-$> enochecker_cli -A http://localhost:8000/ -a 192.168.2.112 putflag
-OK
-$> enochecker_cli -A http://localhost:8000/ -a 192.168.2.112 getflag
-OK
-$> enochecker_cli -A http://localhost:8000/ -a 192.168.2.112 putnoise
-OK
-$> enochecker_cli -A http://localhost:8000/ -a 192.168.2.112 getnoise
-OK
-$> enochecker_cli -A http://localhost:8000/ -a 192.168.2.112 -v 2 havoc
-OK
-```
-
-## Automatically
-You will use CI/CD to continuously check the checker and service. 
-
-- First, install `enochecker_test`.
-- Wipe your checker's and service's `./data/` directories as `enochecker_test` requires a clean state.
-- Run `enochecker_test`:
-
-```
-ENOCHECKER_TEST_CHECKER_ADDRESS='localhost' ENOCHECKER_TEST_CHECKER_PORT='8000' ENOCHECKER_TEST_SERVICE_ADDRESS='192.168.2.112' enochecker_test
-```
+# Documentation
+Detailed documentation is stored in `documentation` directory. It contains all the information about functionality, architecture, vulnerabilities and other aspects of the application.