Commit 528696b9 authored by Volkov Gherman's avatar Volkov Gherman

Fill readme file

parent f4f758cf
# DocuSign_test_project # DocuSign_test_project
DocuSign signature test integration with python DRF service DocuSign signature test integration with python DRF service
Проект подразумевает то, что Вы уже дали согласие на отправку письма на почту.
## Технологии
- [Django](https://docs.djangoproject.com/en/4.2/)
- [Django Rest Framework](https://www.django-rest-framework.org/)
- [Python](https://www.python.org/)
## Использование
Для начала работы приложения нужно:
Вы можете запустить проект двумя разными способами, локально и с помощью контейнера докер
Начнем с запуска приложения локально
Создайте виртуальное окружение с помощью команды:
```sh
$ python3 -m venv venv
```
Активируйте его:
```sh
$ source venv/bin/activate
```
Установите в него все зависимости:
```sh
$ pip install -r requirements/base.txt
```
После этого проведите миграции:
```sh
python3 manage.py migrate
```
Следом запустите сам проект:
```sh
python3 manage.py runserver
```
## Разработка
### Требования
Для установки и запуска проекта, необходим [Python](https://www.python.org/) v3.10+.
### Установка зависимостей
Для установки зависимостей, выполните команду:
```sh
$ pip install -r requirements/base.txt
```
### Проведение миграций
После этого проведите миграции:
```sh
python3 manage.py migrate
```
### Запуск Development сервера
Чтобы запустить сервер для разработки, выполните команду:
```sh
python3 manage.py runserver
```
### Запуск Development сервера через Docker
Чтобы запустить сервер для разработки,через Docker выполните команду:
```sh
docker-compose up
```
## Как пользоваться
Переидите по ссылке:
- если запустили локально - http://127.0.0.1:8000
- если запустили через Docker - http://0.0.0.0
Переидя по ссылке заполните форму, после чего проверьте почту по емейлу который Вы указали в форме, Вам должно прийти письмо с ссылкой на
подпись документа, Вам остается только выполнить эти шаги
### Зачем вы разработали этот проект?
Чтобы выполнить пользователи могли подписывать документы онлайн
## To do
- [x] Создание наброска проекта, с шаблонами и подключением к БД
- [x] Интегрировать приложение DocuSign в проект
- [x] Развернуть сервис в Docker
- [x] Добавить крутое README
- [ ] Добавить страницу с отображением статуса пользователю
- [ ] Покрыть приложение тестами
- [ ] Отполировать все до блеска
## Источники
- [DocuSign](https://www.docusign.com/)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment