Python backend for a Slack's kudos plugin.
chore: updated README
+18
-11
+18
-11
README.md
+18
-11
README.md
···
6
6
7
7
# Welcome to Kefi community!
8
8
9
-
## Run in local
9
+
## Basic setup
10
10
11
11
To be able to run Kefi in you own computer, for development proposes, first, you'll
12
12
need the following software installed and configured:
···
17
17
18
18
This project uses environment variables to handle the configuration, following the [twelve-factor config recommendation](https://12factor.net/config), and we recommend to use [direnv](https://direnv.net/) to handle project's local environment variables.
19
19
20
-
### 1. Clone the repository
20
+
### Clone the repository
21
21
22
22
First, just clone this repository in your machine.
23
23
24
-
### 2. Create environment variables
24
+
### Create environment variables
25
25
26
26
Assuming you are using [direnv](https://direnv.net/), on the root of the project, creates a file named `.envrc`:
27
27
···
55
55
KEFI_SETTINGS_MODULE=kefi.config.local
56
56
57
57
58
-
### 3. Launch the external services
58
+
### Launch the external services
59
59
60
60
To launch the database an Redis server, you can launch them using `docker-compose`:
61
61
62
62
$ docker-compose up --build
63
63
64
-
### 4. Install the dependencies
64
+
### Install the dependencies
65
65
66
66
You can install the dependencies of the project using [poetry](https://python-poetry.org/),
67
67
in a local virtual environment, using the following command:
68
68
69
69
$ poetry install
70
70
71
-
### 5. Run tests
71
+
72
+
## Running tests
72
73
73
74
Now, to test that everything is working, you can launch the tests using this command:
74
75
75
-
poetry run pytest .
76
+
$ poetry run pytest .
77
+
78
+
## Running local server
76
79
77
-
### 6. Run database migrations
80
+
### Database migrations
78
81
79
-
poetry run alembic upgrade head
82
+
First, we have to run the migrations in order to get the last version of the database:
80
83
81
-
### 7. Run server
84
+
$ poetry run alembic upgrade head
82
85
83
-
poetry run uvicorn kefi.main:app --reload
86
+
### Run server
87
+
88
+
Then, we launch the local server with `uvicorn`:
89
+
90
+
$ poetry run uvicorn kefi.main:app --reload