add readme and .env.example

Author: nvo87

.gitignore

@@ -1,5 +1,6 @@
 .local
 .idea
+!.env.example
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -1,7 +1,25 @@
-TODO
+## Installing on a local machine
+This project requires python 3.10. Deps are managed by [pip-tools](https://github.com/jazzband/pip-tools)
 
-1. поставить линтер
-2. pyproject.toml
-3. сделать проверку подписи в запросах от сентри
-4. загрузка .env
-5. посылать сообщения в БК через селери
+Install requirements:
+
+```bash
+$ pip install --upgrade pip pip-tools
+$ pip-sync requirements.txt
+```
+
+Run the server:
+
+```bash
+$ cp src/.env.example src/.env  # default environment variables
+$ uvicorn src.main:app
+```
+
+Testing:
+```bash
+# run lint
+$ make lint
+
+# run unit tests
+$ make test
+```

src/.env.example

@@ -0,0 +1,6 @@
+DEBUG=False
+
+BASECAMP_ACCOUNT_ID=bc-acc-id
+BASECAMP_CHATBOT_KEY=bc-bot-key
+BASECAMP_PROJECT_ID=111
+BASECAMP_CHAT_ID=111