{"id":27992962,"url":"https://github.com/nightmaregaurav/personal-website-cms","last_synced_at":"2025-05-08T18:44:23.286Z","repository":{"id":62628131,"uuid":"529451652","full_name":"nightmaregaurav/personal-website-cms","owner":"nightmaregaurav","description":"Notice: This project is being reworked on as a private repo, as a result, the project will not receive any updates","archived":false,"fork":false,"pushed_at":"2025-04-24T02:56:08.000Z","size":13927,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-24T03:32:17.742Z","etag":null,"topics":["cms","micro-cms","personal-website"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nightmaregaurav.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-08-27T01:37:47.000Z","updated_at":"2025-04-24T02:56:12.000Z","dependencies_parsed_at":"2023-01-26T07:46:39.488Z","dependency_job_id":"74c12a9b-960e-4548-8494-fb81125033c5","html_url":"https://github.com/nightmaregaurav/personal-website-cms","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nightmaregaurav%2Fpersonal-website-cms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nightmaregaurav%2Fpersonal-website-cms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nightmaregaurav%2Fpersonal-website-cms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nightmaregaurav%2Fpersonal-website-cms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nightmaregaurav","download_url":"https://codeload.github.com/nightmaregaurav/personal-website-cms/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253132070,"owners_count":21859101,"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":["cms","micro-cms","personal-website"],"created_at":"2025-05-08T18:44:22.824Z","updated_at":"2025-05-08T18:44:23.276Z","avatar_url":"https://github.com/nightmaregaurav.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Micro CMS for statically hosted personal website [Personal Website CMS]\nThis minimal CMS runs using client side technology so that it can also be hosted on a server that can only host static websites. It uses JSON api to make things Dynamic. It provides Setup GUI to allow editing the website contents and configuration.\n\u003cbr\u003e\n`It's not jekyll.` `Personal-Website-CMS` is built using React and depends on one or more configuration files. This app uses the [React Router](https://reactrouter.com/) library to make routing easier.\n\n![](1.png)\n\n| ![](2.png) | ![](3.png) |\n|:----------:|:----------:|\n\n# Features\n* ### Classic Features\n    * About Page\n    * Education Page\n    * Experience Page\n    * Projects Page\n    * Individual project's page\n    * Gallery Page\n    * Services Page\n    * Skills Page\n    * Contact Page\n    * Setup Page\n* ### Additional Features\n  * Completely dynamic setup.\n  * Dynamic content is generated on the fly.\n  * Dynamic content is generated using JSON api.\n  * Supports GitHub Pages (and give extra features like saving configuration on button click).\n  * Fast and easy to set up.\n  * Cheap to host static project on a server.\n  * Complete customization.\n\n## Installation\n* ### On GitHub pages\n  1. Fork the repository, preferably with name `{your-username}.github.io`\n  2. Go to settings and enable GitHub pages. This may take some time. Visit `{your-username}.github.io` or the domain you chose to verify and move to next step.\n  3. Perform Step 2, 3, \u0026 4 of [Upgrade Section](#upgrade).\n  4. Follow Steps in [Maintenance Section](#maintenance) for website setup and customization.\n\n* ### On your own server\n  1. Open terminal inside `public_html` or `wwwroot` or equivalent folder. (referred as `www-folder`).\n  2. Run `git clone https://github.com/nightmaregaurav/personal-website-cms.git .`\n     * Make sure the `www-folder` is empty before you perform this step.\n  3. Perform Step 2, 3, \u0026 4 of [Upgrade Section](#upgrade).\n  4. Follow Steps in [Maintenance Section](#maintenance) for website setup and customization.\n\n## Opening Setup UI\n* Navigate to `\u003croot\u003e/setup` URL\n* That may fail to work in some cases.\n* Use the key you chose in previous setup with Ctrl+Shift+Alt (Default key is `s` if you haven't set any).\n\n## Maintenance\n1. Open setup page.\n2. Make Changes.\n3. Click `Save config.json`\n   * For GitHub Page, it will automatically commit and push the changes to the repository.\n   * For other hosting, you have to manually commit and push the changes(or upload) to the server.\n4. Wait for the changes to take effect. (It may take 1 to 5 minutes, Check your website to verify).\n5. Reopen and reload setup page.\n6. Click `Save sitemap.xml`\n   * For GitHub Page, it will automatically commit and push the changes to the repository.\n   * For other hosting, you have to manually commit and push the changes(or upload) to the server.\n7. Sit back and relax.\n\n## Upgrade\n1. Pull from upstream or Sync fork.\n2. Open setup page.\n3. Click `Fix 404.html`. \n   * For GitHub Page, it will automatically commit and push the changes to the repository.\n   * For other hosting, you have to manually commit and push the changes(or upload) to the server.\n4. Click `Fix index.html`.\n   * For GitHub Page, it will automatically commit and push the changes to the repository.\n   * For other hosting, you have to manually commit and push the changes(or upload) to the server.\n5. Done\n\n### IMPORTANT\n* #### It is recommended that you DO NOT add/modify files in the repository manually unless you really know what you are doing.\n* #### If you need to serve static files in any special case, you can do so in and only in 'data' folder in the root of the repo\u003c/b\u003e\n\n### Sometimes, those who view this repository are looking for the [Source Repository](https://github.com/nightmaregaurav/personal-website-cms-source)\n\n## This repository is only for\n* Forking/Cloning and hosting the website.\n* Discussion related to non-technical topics related to this CMS.\n\n---\n## Note: This Project is Licensed under GNU GPLv3.\n\n### Which means Anyone are permitted for:\n- Commercial use: **The licensed material and derivatives may be used for commercial purposes.**\n- Distribution: **The licensed material may be distributed.**\n- Modification: **The licensed material may be modified.**\n- Patent use: **This license provides an express grant of patent rights from contributors.**\n- Private use **The licensed material may be used and modified in private.**\n\n### Under Condition that:\n- Disclose source: **Source code must be made available when the licensed material is distributed.**\n- License and copyright notice: **A copy of the license and copyright notice must be included with the licensed material.**\n- Same license: **Modifications must be released under the same license when distributing the licensed material. In some cases a similar or related license may be used.**\n- State changes: **Changes made to the licensed material must be documented. Along with link to original source**\n\n### Note that rehosting [Release Repository](https://github.com/nightmaregaurav/personal-website-cms) or [Source Repository](https://github.com/nightmaregaurav/personal-website-cms-source) instead of forking and/or removing credits/backlinks/ownership-info from either of them is strictly against the license term of this project and such actions are sueable in a court of law.\n\n---\nFor Issues, Contributions, and Source Code: Visit the [Source Repository](https://github.com/nightmaregaurav/personal-website-cms-source)\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnightmaregaurav%2Fpersonal-website-cms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnightmaregaurav%2Fpersonal-website-cms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnightmaregaurav%2Fpersonal-website-cms/lists"}