README

Qualité du code

Description

concrete-datastore est un Datastore HTTP REST très polyvalent basé sur le framework Web Django.

Il est principalement utilisé comme serveur de base de données HTTP pour une application Web monopage (AWM).

Contrairement à un serveur de base de données classique tel que PostgreSQL ou MySQL où les requêtes sont effectuées à l'aide du langage SQL, chaque opération est effectuée à l'aide de requêtes HTTP simples.

concrete-datastore peut être considéré comme un serveur NoSQL ou comme une alternative à Firebase.

Démarrage rapide

git clone https://github.com/Netsach/concrete-datastore.git
cd concrete-datastore
docker run --name postgres-concrete-datastore -e POSTGRES_DB=db-concrete-datastore -e POSTGRES_USER=user-concrete-datastore -e POSTGRES_PASSWORD=pwd-concrete-datastore -d -p XXXX:5432 postgis/postgis:12-master
export POSTGRES_PORT=XXXX
export DATAMODEL_FILE=./docs/assets/sample-datamodel.yml
python3 -m venv env
source env/bin/activate
pip install -e ".[full]"
concrete-datastore makemigrations
concrete-datastore migrate
concrete-datastore createsuperuser
concrete-datastore runserver

Naviguez maintenant jusqu'à http://127.0.0.1:8000/concrete-datastore-admin/

Vous pouvez maintenant créer un jeton pour utiliser l'API (ou utiliser le Endpoint d'authentification).

Fonctionnalités

concrete-datastore est livré avec de nombreuses fonctionnalités intégrées telles que :

• Gestion des utilisateurs et des autorisations
• Backoffice généré automatiquement pour les administrateurs
• API entièrement REST utilisant JSON comme format de sérialisation
• Génération de statistiques simples
• Capacités d'envoi d'e-mails à partir de l'API
• ...

Comment ça marche ?

Afin de décrire le schéma de la base de données, le développeur doit écrire un fichier datamodel en YAML ou JSON. Ce fichier datamodel permet à concrete-datastore de gérer la base de données sous-jacente à l'aide de PostgreSQL.

Chaque demande d'API est contrôlée par ce fichier datamodel car il agit comme une spécification de ce qui se trouve dans la base de données et de ce qui devrait être autorisé par chaque utilisateur.

Vous pouvez créer manuellement le fichier datamodel en suivant les exemples et la documentation ou utiliser l'éditeur en ligne platform.concrete-datastore

F.A.Q

Si vous avez des questions, elles ont peut-être déjà été répondues dans le FAQS.md

Documentation officielle

Voir la documentation officielle

Version Anglaise

Vous pouvez retrouver la version Anglaise ici