Add documentation on setup and development

README.md

@@ -11,3 +11,51 @@ Here is what ChatGPT has to say about Nastenka:
 >But the best part about Nastenka is that it's completely self-hosted, which means you have full control over your data. You can rest easy knowing that your information is safe and secure, and that you have full control over who has access to it.
 >
 >So why wait? Get organized and simplify your life with Nastenka today!
+
+## Setup
+
+**Environment variables:**
+
+- `DATABASE_URL=postgresql://postgres:postgres@localhost:5432/nastenka` - The URL for connecting to the Postgresql database.
+- `PORT=8080` - The internal port on which the backend server will run.
+- `BOT_USER_ID` - Your Telegram user ID.
+- `BOT_TOKEN` - The token for your personal Telegram bot.
+- `EMAIL_USER` - The username associated with your email account.
+- `EMAIL_PASSWORD` - The password (or application-specific password) associated with your email account.
+- `EMAIL_FOLDER=Nastenka` - Name of the folder in your email account where you should move emails from Nastenka. You should create this folder and set up rules for automatically moving relevant emails into it.
+- `[email protected]` - The email address or alias that you will use to forward emails to Nastenka.
+- `EMAIL_URL=imap://imap.fastmail.com:993` - The IMAP URL for accessing your email account.
+- `AWS_REGION=us-east-1` - This should always be set to `us-east-1` for Minio.
+- `AWS_ACCESS_KEY_ID` - Your AWS (Minio) access key ID.
+- `AWS_SECRET_ACCESS_KEY` - Your AWS (Minio) secret access key.
+- `S3_BUCKET_NAME=nastenka` - The name of the S3 bucket where Nastenka files will be stored.
+- `S3_ENDPOINT_URL=http://127.0.0.1:9000` - The endpoint URL for the S3-compatible API provided by the self-hosted Minio service.
+- `S3_PUBLIC_BUCKET_URL=http://localhost:9000/nastenka` - The public URL for the Nastenka S3 bucket. The bucket should be configured to allow public access.
+
+## Development
+
+Open three terminal windows or panes and run the following commands:
+
+**Pane 1**
+*Installs frontend dependencies and runs the development server*
+```shell
+cd frontend
+yarn install
+yarn exec vite
+```
+
+**Pane 2**
+*Compiles and runs the http server*
+```shell
+<env-variables> sbt
+~ backend/reStart
+```
+
+**Pane 3**
+*Compiles the frontend JavaScript*
+```shell
+sbt
+~ frontend/fastLinkJS
+```
+
+Then open the browser and navigate to [localhost:3000/app/](http://localhost:3000/app/).