https://github.com/nightmaregaurav/personal-website-cms
Notice: This project is being reworked on as a private repo, as a result, the project will not receive any updates
https://github.com/nightmaregaurav/personal-website-cms
cms micro-cms personal-website
Last synced: about 1 year ago
JSON representation
Notice: This project is being reworked on as a private repo, as a result, the project will not receive any updates
- Host: GitHub
- URL: https://github.com/nightmaregaurav/personal-website-cms
- Owner: nightmaregaurav
- License: other
- Created: 2022-08-27T01:37:47.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-24T02:56:08.000Z (about 1 year ago)
- Last Synced: 2025-04-24T03:32:17.742Z (about 1 year ago)
- Topics: cms, micro-cms, personal-website
- Language: HTML
- Homepage:
- Size: 13.3 MB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Micro CMS for statically hosted personal website [Personal Website CMS]
This 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.
`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.
|  |  |
|:----------:|:----------:|
# Features
* ### Classic Features
* About Page
* Education Page
* Experience Page
* Projects Page
* Individual project's page
* Gallery Page
* Services Page
* Skills Page
* Contact Page
* Setup Page
* ### Additional Features
* Completely dynamic setup.
* Dynamic content is generated on the fly.
* Dynamic content is generated using JSON api.
* Supports GitHub Pages (and give extra features like saving configuration on button click).
* Fast and easy to set up.
* Cheap to host static project on a server.
* Complete customization.
## Installation
* ### On GitHub pages
1. Fork the repository, preferably with name `{your-username}.github.io`
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.
3. Perform Step 2, 3, & 4 of [Upgrade Section](#upgrade).
4. Follow Steps in [Maintenance Section](#maintenance) for website setup and customization.
* ### On your own server
1. Open terminal inside `public_html` or `wwwroot` or equivalent folder. (referred as `www-folder`).
2. Run `git clone https://github.com/nightmaregaurav/personal-website-cms.git .`
* Make sure the `www-folder` is empty before you perform this step.
3. Perform Step 2, 3, & 4 of [Upgrade Section](#upgrade).
4. Follow Steps in [Maintenance Section](#maintenance) for website setup and customization.
## Opening Setup UI
* Navigate to `/setup` URL
* That may fail to work in some cases.
* Use the key you chose in previous setup with Ctrl+Shift+Alt (Default key is `s` if you haven't set any).
## Maintenance
1. Open setup page.
2. Make Changes.
3. Click `Save config.json`
* For GitHub Page, it will automatically commit and push the changes to the repository.
* For other hosting, you have to manually commit and push the changes(or upload) to the server.
4. Wait for the changes to take effect. (It may take 1 to 5 minutes, Check your website to verify).
5. Reopen and reload setup page.
6. Click `Save sitemap.xml`
* For GitHub Page, it will automatically commit and push the changes to the repository.
* For other hosting, you have to manually commit and push the changes(or upload) to the server.
7. Sit back and relax.
## Upgrade
1. Pull from upstream or Sync fork.
2. Open setup page.
3. Click `Fix 404.html`.
* For GitHub Page, it will automatically commit and push the changes to the repository.
* For other hosting, you have to manually commit and push the changes(or upload) to the server.
4. Click `Fix index.html`.
* For GitHub Page, it will automatically commit and push the changes to the repository.
* For other hosting, you have to manually commit and push the changes(or upload) to the server.
5. Done
### IMPORTANT
* #### It is recommended that you DO NOT add/modify files in the repository manually unless you really know what you are doing.
* #### 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
### Sometimes, those who view this repository are looking for the [Source Repository](https://github.com/nightmaregaurav/personal-website-cms-source)
## This repository is only for
* Forking/Cloning and hosting the website.
* Discussion related to non-technical topics related to this CMS.
---
## Note: This Project is Licensed under GNU GPLv3.
### Which means Anyone are permitted for:
- Commercial use: **The licensed material and derivatives may be used for commercial purposes.**
- Distribution: **The licensed material may be distributed.**
- Modification: **The licensed material may be modified.**
- Patent use: **This license provides an express grant of patent rights from contributors.**
- Private use **The licensed material may be used and modified in private.**
### Under Condition that:
- Disclose source: **Source code must be made available when the licensed material is distributed.**
- License and copyright notice: **A copy of the license and copyright notice must be included with the licensed material.**
- 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.**
- State changes: **Changes made to the licensed material must be documented. Along with link to original source**
### 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.
---
For Issues, Contributions, and Source Code: Visit the [Source Repository](https://github.com/nightmaregaurav/personal-website-cms-source)
---