OSMA/osma-server
1
0
Fork 0
mirror of https://github.com/OSMA-D/osma-server.git synced 2024-11-23 13:26:23 +03:00
Code Issues Projects Releases Packages Wiki Activity

doc: getting started

Browse source
This commit is contained in:
Artemy 2022-07-28 20:16:34 +03:00
parent 2cf76d8c0f
commit fb577dd3f7
2 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -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,

16
docs/guides/getting-started.md
View file

@ -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