Giter VIP home page Giter VIP logo

django-sy-notes's Introduction

Микросервис ведения заметок

Введение

Микросервис хранит ваши мысли и идеи в виде заметок, помогает через Telegram-бота находить в массе заметок нужную информацию.

Микросервис обладает как веб-интрефейсом, так и удобным API для интеграции с любимыми сторонними сервисами.

Философия

  • для пользователя не должно быть разницы в возможностях по причине того, в какой базе хранится заметка, с которой он работает;
  • пользователь может сделать заметкой любую форму данных, которую возможно записать текстом;
  • пользователь или сообщество самостоятельно решает, по каким правилам вести заметки;
  • заголовок заметки - это её уникальный идентификатор;
  • предпочтительно, чтобы другие микросервисы автоматически экспортировали свои данные в микросервис заметки. Например, микросервис фасилитации может представлять холсты в виде заметок. Это универсализирует поиск по данным, облегчит связывание данных для пользователя.

Запуск

Скачивание репозитория:

git clone https://github.com/syeysk/django-sy-notes

Установка зависимостей:

pip install -r requirements.txt

Применение миграций:

python manage.py migrate

Заполнить переменные окружения, добавив и заполнив файл .env

Запуск сервера:

python manage.py runserver

Проверка доступности сервера:

https://cachebrain.fun/api/v1/note/search/query/

HTTP/2 200 возвращает JSON ответ.

API сервера

Документация API

План разработки микросервиса

django-sy-notes's People

Contributors

redboo avatar shyzik93 avatar syeysk avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.