Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paranoid-software/elemental-cms
Flask + MongoDB web CMS
https://github.com/paranoid-software/elemental-cms
cms flask mongodb python web
Last synced: 5 days ago
JSON representation
Flask + MongoDB web CMS
- Host: GitHub
- URL: https://github.com/paranoid-software/elemental-cms
- Owner: paranoid-software
- License: mpl-2.0
- Created: 2021-11-23T20:12:44.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-04T20:44:25.000Z (2 months ago)
- Last Synced: 2024-10-06T07:16:40.051Z (about 1 month ago)
- Topics: cms, flask, mongodb, python, web
- Language: Python
- Homepage: https://paranoid.software/elemental-cms
- Size: 376 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# elemental CMS
Elemental is a Flask and MongoDB web CMS intended for developers.
Our main goal is to allow developers to create and maintain web portals or web applications using their preferred programming IDE like VS Code, PyCharm, Visual Studio, etc.
The main interaction with the tool takes place through its CLI, a self documented command line tool called "elemental-cms" which helps us perform deployment tasks directly from the terminal.
It relies on MongoDB to store the metadata, pages' content, snippets' content, dependencies information, and user session data.
## Work in progress
- Official documentation construction
- Media files management on GCS module test classes
- Static files management on GCS module test classes
- Pages management module review and refactor
- Samples review and update
## To Do
- Resources names validation
- Configurations schema review
- Test coverage review
- Support for detailed comparison between local and remote resources versions
- Support for sample settings file generation
## Setup #
Once we have our project folder created and our virtual environment in place, we proceed to install Elemental CMS using pip.
```shell
pip install elemental-cms
```
The CLI includes an "init" command which will create a basic working directory structure.
Before we can issue the "init" command, we have to create a config file inside a "settings" folder with at least the following content:
```json
{
"cmsCoreContext": {
"DEBUG": true,
"ENV": "development",
"SECRET_KEY": "the-secret",
"SITE_NAME": "Elemental CMS",
"COMPANY": "Your company name",
"CANONICAL_URL": "https://elemental.cms",
"LANGUAGES": [
"en",
"es"
],
"DEFAULT_LANGUAGE": "en",
"LANGUAGE_MODE": "multi",
"STATIC_FOLDER": "static",
"MEDIA_FOLDER": "media",
"STATIC_URL": "https://storage.googleapis.com/static-files-bucket",
"MEDIA_URL": "https://storage.googleapis.com/media-files-bucket",
"STATIC_BUCKET": "static-files-bucket",
"MEDIA_BUCKET": "media-files-bucket",
"GLOBAL_DEPS_FOLDER": "workspace/global_deps",
"PAGES_FOLDER": "workspace/pages",
"SNIPPETS_FOLDER": "workspace/snippets",
"GOOGLE_SERVICE_ACCOUNT_INFO": {
"type": "service_account",
},
"USER_IDENTITY_SESSION_KEY": "userIdentity",
"SESSION_STORAGE_ENABLED": true,
"SESSION_TIMEOUT_IN_MINUTES": 360
},
"cmsDbContext": {
"id": "your-id",
"connectionString": "mongodb://your-username:your-pwd@your-host-name:27017/admin?directConnection=true",
"databaseName": "elemental_playground"
}
}
```
After we create the config file under the name for example local.cli.json, we can issue the "init" command as shown below:
```shell
elemental-cms init -c settings/local.cli.json
```
Executing this command will create and update our .elemental metadata file setting the "configFilePath" property to "settings/local.cli.json", and it will update the folder structure which will ends looking like this:
```lang-none
workdir
└───media
└───settings
└───local.cli.json
└───static
└───templates
└───base.html
└───translations
└───workspace
└───global_deps
└───pages
└───snippets
└───.elemental
```
> Be aware of that in Windows OS using Visual Studio 2019 after running the init command (and any other command that modify the folders and files structure), the created files and folders will not be added to the project automaticaly.
## Creating your first page
To create a new page, we start by issuing the "pages create" CLI command:
```shell
elemental-cms pages create -p home en
```
This will create the page content file and the page spec file under the workspace/pages/en directory.
### Spec file
The spec file will have the page metadata. The structure of the file will look like this:
```json
{
"_id": {
"$oid": "619b8f70f065731d43fb11fc"
},
"name": "home",
"language": "en",
"title": "home page",
"description": "",
"isHome": false,
"cssDeps": [],
"jsDeps": [],
"createdAt": {
"$date": 1637584752066
},
"lastModifiedAt": {
"$date": 1637584752066
}
}
```
### Content file
The content file will have the HTML for the page.
```html
```
## Pushing a page
In order to push a page, we must use the "pages push" command:
```shell
elemental-cms pages push -p home en
```
This will save the metadata and content into the database, creating a "draft" version of the page.
## Publishing a page
Until now the new page is stored on the "drafts" repository, in order to be accessible through the web application we must publish the page by running the following command:
```shell
elemental-cms pages publish -p home en
```
## Running the app
We have created a multilanguage page and successfully published it, but we are missing our application entry point.
Since this framework is based on Flask we can create an entry point just like we will do it for any other Flask application; a simple boilerplate can be found down below:
```python
import json
import os
from elementalcms import Elemental, ElementalContext
from elementalcms.core import FlaskContext, MongoDbContext
from flask import Flask
www = Flask(__name__, template_folder='templates', static_folder='static')
CONFIG_FILEPATH = os.environ.get('CONFIG_FILEPATH', 'settings/local.www.json')
with open(CONFIG_FILEPATH) as config_file:
settings = json.load(config_file)
cms_core_context = FlaskContext(settings['cmsCoreContext'])
cms_db_context = MongoDbContext(settings['cmsDbContext'])
elemental_context = ElementalContext(cms_core_context, cms_db_context)
Elemental(www, elemental_context)
if __name__ == '__main__':
www.run(host='0.0.0.0', port=8000)
```
Note that in order to run the app locally we need another setting file (local.www.sjon) with some minor modifications. Like the one shown below:
```json
{
"cmsCoreContext": {
"DEBUG": true,
"ENV": "development",
"SECRET_KEY": "the-secret",
"SITE_NAME": "Elemental CMS",
"COMPANY": "Your company name",
"CANONICAL_URL": "https://elemental.cms",
"LANGUAGES": [
"en",
"es"
],
"DEFAULT_LANGUAGE": "en",
"LANGUAGE_MODE": "multi",
"STATIC_FOLDER": "static",
"MEDIA_FOLDER": "media",
"STATIC_URL": "/static",
"MEDIA_URL": "/media",
"GLOBAL_DEPS_FOLDER": "workspace/global_deps",
"PAGES_FOLDER": "workspace/pages",
"SNIPPETS_FOLDER": "workspace/snippets",
"USER_IDENTITY_SESSION_KEY": "userIdentity",
"SESSION_STORAGE_ENABLED": true,
"SESSION_TIMEOUT_IN_MINUTES": 360,
"DESIGN_MODE_ENABLED": true
},
"cmsDbContext": {
"id": "your-id",
"connectionString": "mongodb://your-username:your-pwd@your-host-name:27017/admin?directConnection=true",
"databaseName": "elemental_playground"
}
}
```
In this file we do not need buckets information, sinces static and media resoruces will be served locally. We do not need a Google Service Account niether because that info is needed only by the cli tool to send local files to GCS.
## Windows OS + Visual Studio 2019
In Visual Studio 2019 we have some minor challenges to get started due to "problems" related with the operative system security policies more than with the tool.
- We start by creating a Python project and adding a virtual environment
- Then visual studio offers developer terminals in at least 2 flavors:
- **Developer PowerShell** where the environment do not get activated by default, so we must activate it by running the command:
```shell
.\.venv\Scripts\Activate.ps1
```
> Depending on your security policies this command will or will not ork. When it does not work it will show an error telling you something like: "Activate.ps1 cannot be loaded because running scripts is disabled on
this system. For more information, see about_Execution_Policies at https:/go.microsoft.com/fwlink/?LinkID=135170."
> To overcome this situation we must enable running scripts at least to the current user, following the official Microsoft documentation.
- **Developer Command Promt** were the environment do not get activated by default, so we must activate it by running the command:
```shell
.venv\Scripts\activate
```
> In both cases we assume you create the virtual environment under the name **.venv**
Resolving this minor setbacks we can go back to the Setup step and follow the getting started guide normaly.