Skip to content

Commit

Permalink
(feat) gramar mistakes inside readme
Browse files Browse the repository at this point in the history
  • Loading branch information
atsanda committed Mar 25, 2021
1 parent a1ee06f commit 581c2e8
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

[![codecov](https://codecov.io/gh/atsanda/candy-shop/branch/main/graph/badge.svg?token=YYQ675YF3V)](https://codecov.io/gh/atsanda/candy-shop)

This is a small REST servise written with [Django REST framework](https://www.django-rest-framework.org/) for managing couriers and orders for a candy shop. It is a part of selection process to [Yandex Backend School](https://yandex.ru/promo/academy/backend-school).
This is a small REST service written with [Django REST framework](https://www.django-rest-framework.org/) for managing couriers and orders for a candy shop. It is a part of selection process to [Yandex Backend School](https://yandex.ru/promo/academy/backend-school).

## Structure

The app implements several apis:
The app implements several APIs:
```
[POST] /couriers
[GET] /couriers/{courier_id}
Expand All @@ -19,7 +19,7 @@ There are several core files for processing each of them:
* a request is recieved inside [views](candy_shop/apps/delivery/views.py),
* then deserialized and validated inside [serializers](candy_shop/apps/delivery/serializers.py),
* business logic is applied from [services](candy_shop/apps/delivery/services.py),
* comlex queries are added moved to [models](candy_shop/apps/delivery/models.py).
* complex queries are moved to [models](candy_shop/apps/delivery/models.py).

## Installation
To install the app for development
Expand All @@ -38,14 +38,14 @@ $ pip install -r requirements.txt
DJANGO_SETTINGS_MODULE=candy_shop.config
DJANGO_CONFIGURATION=Local
```
* run test to check your installation
* run tests to check your installation
```.bash
$ pytest
```

## Deployment

The app was deployed to corresponding virtual machine, which was given to all entrants. My settings for deployment were taken from [this video](https://youtu.be/FLiKTJqyyvs). The video offers to deploy through gunicorn, nginx and supervisor, which I did.
The app was deployed to the corresponding virtual machine, which was given to all entrants. My setup for deployment were taken from [this video](https://youtu.be/FLiKTJqyyvs). The video offers to deploy through gunicorn, nginx and supervisor, which I did.

## Tests

Expand Down

0 comments on commit 581c2e8

Please sign in to comment.