maj readMe

This commit is contained in:
Laetitia Getti 2023-03-30 14:15:11 +02:00
parent 2c5eda993a
commit c06e48c7fd
2 changed files with 9 additions and 167 deletions

View file

@ -1,166 +0,0 @@
Exemple de MCD en markdown avec mermaid :
```mermaid
erDiagram
CourseSubmission{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
CharField title
DateField date
FSMField state
}
CourseSubmissionProduct{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
PositiveSmallIntegerField quantity
}
Pricing{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
CharField name
}
Product{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
CharField name
CharField code
BooleanField submission_enabled
}
ProductPrice{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
PositiveSmallIntegerField year
CharField price_type
DecimalField price_flat
PositiveSmallIntegerField price_percent
DecimalField price_percent_minimum
CharField unit
}
ProductPriceRange{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
PositiveSmallIntegerField range_start
PositiveSmallIntegerField range_end
DecimalField unit_price
DecimalField minimum
}
ProductPricePackLine_included_products{
AutoField id
}
ProductPricePackLine{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
CharField quantity_type
PositiveSmallIntegerField quantity
}
Contract{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
DateField start
DateField end
FileField file
}
Transaction_products{
AutoField id
}
Transaction{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
PositiveIntegerField debit
PositiveIntegerField credit
BooleanField unlimited_credit
}
Quote{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
CharField external_ref
FSMField state
}
QuoteLine{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
TextField label
DecimalField unit_price
DecimalField quantity
}
Invoice{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
CharField external_ref
FSMField state
}
InvoiceLine{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
TextField label
DecimalField unit_price
DecimalField quantity
}
User{
CharField password
DateTimeField last_login
BooleanField is_superuser
CharField username
CharField first_name
CharField last_name
EmailField email
BooleanField is_staff
BooleanField is_active
DateTimeField date_joined
UUIDField id
DateTimeField created_on
DateTimeField updated_on
ManyToManyField groups
ManyToManyField user_permissions
}
Organization{
UUIDField id
DateTimeField created_on
DateTimeField updated_on
CharField code
CharField representative
FileField signature
FileField logo
}
CourseSubmission||--|{User : user
CourseSubmission||--|{Organization : organization
CourseSubmissionProduct||--|{CourseSubmission : course_submission
CourseSubmissionProduct||--|{Product : product
ProductPrice||--|{Pricing : pricing
ProductPrice||--|{Product : product
ProductPriceRange||--|{ProductPrice : product_price
ProductPricePackLine_included_products||--|{ProductPricePackLine : productpricepackline
ProductPricePackLine_included_products||--|{Product : product
ProductPricePackLine||--|{ProductPrice : product_price
ProductPricePackLine}|--|{Product : included_products
Contract||--|{Organization : organization
Contract||--|{Pricing : pricing
Transaction_products||--|{Transaction : transaction
Transaction_products||--|{Product : product
Transaction||--|{Invoice : invoice
Transaction||--|{CourseSubmission : course_submission
Transaction}|--|{Product : products
Quote||--|{Organization : organization
QuoteLine||--|{Quote : quote
QuoteLine||--|{Product : product
Invoice||--|{Organization : organization
InvoiceLine||--|{Invoice : invoice
InvoiceLine||--|{Product : product
Organization||--|{User : representative_user
Organization||--|{Organization : parent
```

View file

@ -1,3 +1,11 @@
# La Chariotte
La Chariotte est une application web sous licence libre Affera GPL, développée et maintenue par [Hashbang](https://hashbang.fr/).
La Chariotte est une application web sous licence libre Affera GPL, développée et maintenue par [Hashbang](https://hashbang.fr/).
## Lancer les tests
Avec pytest,
```bash
pytest
```