From fb577dd3f7b591c700b4bafb08373906feffcf79 Mon Sep 17 00:00:00 2001 From: Artemy Date: Thu, 28 Jul 2022 20:16:34 +0300 Subject: [PATCH] doc: getting started --- CONTRIBUTING.md | 2 ++ docs/guides/getting-started.md | 16 ++++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 79b00cc..00fe177 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,7 @@ `work in progress` +### [Getting started guide](docs/guides/getting-started.md) + # Contributing When contributing to this repository, please first discuss the change you wish to make via issue, diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md index e69de29..4b9fd4b 100644 --- a/docs/guides/getting-started.md +++ b/docs/guides/getting-started.md @@ -0,0 +1,16 @@ +## How to run + +### 1. Create .env file or configure environment variables manually + +```.env +MONGODB_URI = *URI* +PORT = 80 +JWT_SECRET = *secret* +SALT = *SALT* +``` + +### 2. Run command + +`cargo run` + +### 3. Enjoy