From 910d2b5621e731b6db4b1ba126feff31bfef3ce3 Mon Sep 17 00:00:00 2001 From: Markos Gogoulos Date: Thu, 6 Jul 2023 19:04:34 +0300 Subject: [PATCH] Dev Exp stub file --- AUTHORS.txt | 4 ---- README.md | 23 ++++++++++++++--------- docker-compose-dev.yaml | 17 ++--------------- docs/dev_exp.md | 2 ++ requirements-dev.txt | 1 - 5 files changed, 18 insertions(+), 29 deletions(-) create mode 100644 docs/dev_exp.md diff --git a/AUTHORS.txt b/AUTHORS.txt index 010ca05..8298c27 100644 --- a/AUTHORS.txt +++ b/AUTHORS.txt @@ -1,5 +1 @@ -Yiannis Stergiou - ys.stergiou@gmail.com -Markos Gogoulos - mgogoulos@gmail.com -Swift Ugandan - swiftugandan@gmail.com - Please see https://github.com/mediacms-io/mediacms/graphs/contributors for complete list of contributors to this repository! \ No newline at end of file diff --git a/README.md b/README.md index 8ddfa8e..a4ab958 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ -MediaCMS is a modern, fully featured open source video and media CMS. It is developed to meet the needs of modern web platforms for viewing and sharing media. It can be used to build a small to medium video and media portal within minutes. +MediaCMS is a modern, fully featured open source video and media CMS. It is developed to meet the needs of modern web platforms for viewing and sharing media. It can be used to build a small to medium video and media portal within minutes. It is built mostly using the modern stack Django + React and includes a REST API. @@ -56,15 +56,15 @@ A demo is available at https://demo.mediacms.io ## Philosophy -We believe there's a need for quality open source web applications that can be used to build community portals and support collaboration. +We believe there's a need for quality open source web applications that can be used to build community portals and support collaboration. -We have three goals for MediaCMS: a) deliver all functionality one would expect from a modern system, b) allow for easy installation and maintenance, c) allow easy customization and addition of features. +We have three goals for MediaCMS: a) deliver all functionality one would expect from a modern system, b) allow for easy installation and maintenance, c) allow easy customization and addition of features. ## License -MediaCMS is released under [GNU Affero General Public License v3.0 license](LICENSE.txt). -Copyright Markos Gogoulos and Yiannis Stergiou +MediaCMS is released under [GNU Affero General Public License v3.0 license](LICENSE.txt). +Copyright Markos Gogoulos ## Support and paid services @@ -73,9 +73,9 @@ We provide custom installations, development of extra functionality, migration f -## Hardware dependencies +## Hardware considerations -For a small to medium installation, with a few hours of video uploaded daily, and a few hundreds of active daily users viewing content, 4GB Ram / 2-4 CPUs as minimum is ok. For a larger installation with many hours of video uploaded daily, consider adding more CPUs and more Ram. +For a small to medium installation, with a few hours of video uploaded daily, and a few hundreds of active daily users viewing content, 4GB Ram / 2-4 CPUs as minimum is ok. For a larger installation with many hours of video uploaded daily, consider adding more CPUs and more Ram. In terms of disk space, think of what the needs will be. A general rule is to multiply by three the size of the expected uploaded videos (since the system keeps original versions, encoded versions plus HLS), so if you receive 1G of videos daily and maintain all of them, you should consider a 1T disk across a year (1G * 3 * 365). @@ -99,6 +99,10 @@ There are two ways to run MediaCMS, through Docker Compose and through installin Visit [Configuration](docs/admins_docs.md#5-configuration) page. +## Information for developers +Check out the new section on the [Developer Experience](docs/dev_exp.md) page + + ## Documentation * [Users documentation](docs/user_docs.md) page @@ -125,9 +129,10 @@ If you like the project, here's a few things you can do - Suggest us to others that are interested to hire us - Write a blog post/article about MediaCMS - Share on social media about the project -- Open issues, participate on discussions, report bugs, suggest ideas +- Open issues, participate on [discussions](https://github.com/mediacms-io/mediacms/discussions), report bugs, suggest ideas +- [Show and tell](https://github.com/mediacms-io/mediacms/discussions/categories/show-and-tell) how you are using the project - Star the project -- Add functionality, work on a PR, fix an issue! +- Add functionality, work on a PR, fix an issue! ## Contact diff --git a/docker-compose-dev.yaml b/docker-compose-dev.yaml index 69cff8e..0db2a29 100644 --- a/docker-compose-dev.yaml +++ b/docker-compose-dev.yaml @@ -8,23 +8,13 @@ services: image: mediacms/mediacms-dev:latest volumes: - ./:/home/mediacms.io/mediacms/ - environment: - ENABLE_UWSGI: 'no' - ENABLE_NGINX: 'no' - ENABLE_CELERY_SHORT: 'no' - ENABLE_CELERY_LONG: 'no' - ENABLE_CELERY_BEAT: 'no' - ADMIN_USER: 'admin' - ADMIN_EMAIL: 'admin@localhost' - #ADMIN_PASSWORD: 'uncomment_and_set_password_here' - command: "./deploy/docker/prestart.sh" + command: "python manage.py migrate" restart: on-failure depends_on: redis: condition: service_healthy db: condition: service_healthy - frontend: image: node:14 volumes: @@ -53,10 +43,7 @@ services: volumes: - ./:/home/mediacms.io/mediacms/ depends_on: - redis: - condition: service_healthy - db: - condition: service_healthy + - migrations db: image: postgres:15.2-alpine volumes: diff --git a/docs/dev_exp.md b/docs/dev_exp.md new file mode 100644 index 0000000..3c423ee --- /dev/null +++ b/docs/dev_exp.md @@ -0,0 +1,2 @@ +# Developer Experience +asd \ No newline at end of file diff --git a/requirements-dev.txt b/requirements-dev.txt index c4d0bac..021bee5 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -12,6 +12,5 @@ pytest-cov pytest-django pytest-factoryboy Faker -whitenoise django-cors-headers