{"id":13300800,"url":"https://github.com/splendid-cms/website","last_synced_at":"2025-03-10T12:32:53.484Z","repository":{"id":64119691,"uuid":"489630519","full_name":"splendid-cms/website","owner":"splendid-cms","description":"An official website for the Splendid CMS","archived":false,"fork":false,"pushed_at":"2022-11-27T17:46:06.000Z","size":378,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2023-03-06T21:26:08.070Z","etag":null,"topics":["fastify","nodejs","template"],"latest_commit_sha":null,"homepage":"","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/splendid-cms.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-05-07T09:34:36.000Z","updated_at":"2023-01-28T04:19:26.000Z","dependencies_parsed_at":"2023-01-14T23:15:49.261Z","dependency_job_id":null,"html_url":"https://github.com/splendid-cms/website","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splendid-cms%2Fwebsite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splendid-cms%2Fwebsite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splendid-cms%2Fwebsite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splendid-cms%2Fwebsite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/splendid-cms","download_url":"https://codeload.github.com/splendid-cms/website/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242852025,"owners_count":20195757,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fastify","nodejs","template"],"created_at":"2024-07-29T17:43:04.557Z","updated_at":"2025-03-10T12:32:53.160Z","avatar_url":"https://github.com/splendid-cms.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Get started with Splendid!\n\nSplendid is a free magnificent **open-source** [Node.js](https://nodejs.org/en/) content management system based on a **fast** web framework [Fastify](https://www.fastify.io/) for publishing web content on websites using [**Markdown**](https://en.wikipedia.org/wiki/Markdown) markup language, **plugins** to improve user experience and **themes** to beautify this experience.\n\n![Splendid website preview](/static/media/splendid-preview.png)\n\n---\n\n## Installation\n\nInstallation process requires you to have a [Node.js](https://nodejs.org/en/) installed on your machine and nothing else.\n\n### Create a project\n\n**Download** one of two given options above: it can be either [zip](#zip) or [tar.gz](#tar)!\n\n### Deploy the project\n\n**Unarchive** or unzip the fresh downloaded folder in `project` root folder.\n\n### Setup the project\n\n**Checkout** `config.json` in order to configure basic information about the website. It may look like\n\n```json\n{\n    \"Website_name\": \"Splendid\",\n    \"Theme\": \"preshow\",\n    \"Icon\": \"favicon.ico\",\n    \"Port\": 3000,\n    \"Plugins\": [],\n    \"Content\": {\n        \"Header\": {\n            \"Name\": \"/home/\",\n            \"Github\": \"https://github.com/splendid-cms\"\n        },\n        \"Sidebar\": {\n            \"Page Name\": \"/link-1/\",\n            \"Category\": {\n                \"Page Name\": \"/link-2/\",\n                \"Subcategory\": {\n                    \"Page Name\": \"/link-3/\"\n                }\n            }\n        },\n        \"Footer\": \"Footer text\"\n    },\n    \"Debug\": false\n}\n```\n\n- Where \"Website_name\" stays for the project name that will be used in header, title etc. (Depends on the theme),\n- \"Theme\" stays for the theme name i.e theme folder name inside the `/content/themes` directory,\n- \"Icon\" for the icon path that will be used in the browser tab (path already starts with `/content/media`),\n- \"Port\" that will be used to server listening,\n- \"Plugins\" for activated plugin names array i.e plugin folder name inside the `/plugins` directory,\n- \"Content\" for the basic content like Header, Sidebar and Footer (Depends on the theme and plugin. Basic version supports these 3),\n- \"Debug\" for logging events.\n\nAfter all done consider running `npm install` in the terminal in order to install missing dependencies that were used for the Splendid.\n\n### Start the server\n\nIt is recommended to use the nodemon starting in order to easily deploy changes without restarting the server. In order to do that use the `npm start` command. If you wish to simply use node command: `node .` or `node views/js/app.js`\n\n---\n\n## Documentation\n\nIf you would like to learn more check out more [here](https://github.com/splendid-cms/docs)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplendid-cms%2Fwebsite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsplendid-cms%2Fwebsite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplendid-cms%2Fwebsite/lists"}