PLaTon Server

REST API of PLaTon written using Django REST Framework.

Development

Prerequisites

Before you start contributing to this backend project, you should be familiar with the following stacks. We recommend also visiting the links listed at the bottom of this page:

• Python >= 3.8
• Pip3
• Django
• Django Channels
• Django REST Framework
• PostgreSQL
• Redis
• Celery
• Uvicorn
• Elasticsearch
• PLaTon sandbox

Getting started

Using this project requires to setup multiple services like a PostgreSQL database, a Redis cache, or Elasticsearch... So instead of installing all theses tools on your system, you should follow the instructions on the main repository of PLaTon project to use a dockerized version of PLaTon during your development or deployment. A documentation is also hosted over there.

Contributing

Contributing guidelines

Read through our contributing guidelines to learn about our submission process, coding rules and more.

Want to help?

Want to report a bug, contribute some code, or improve the platform? Read up on our guidelines for contributing and then check out one of our issues labeled as help wanted or submit a new one.

Links

• Django tutorial
• Django Channels tutorial
• Django Elasticsearch tutorial
• Django REST Framework tutorial
• Django + Frontend Frameworks tutorial
• Django + Docker + Nginx tutorial
• Django + Docker + Redis + Celery tutorial
• Django Elasticsearch + Django REST Framework tutorial