Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prabapro/slcfhr-hugo-website
Hugo website for Siri Lakxmi Center For Human Rehabilitation (Sri Lakxmi Ayurveda)
https://github.com/prabapro/slcfhr-hugo-website
decap-cms hugo netlify
Last synced: 11 days ago
JSON representation
Hugo website for Siri Lakxmi Center For Human Rehabilitation (Sri Lakxmi Ayurveda)
- Host: GitHub
- URL: https://github.com/prabapro/slcfhr-hugo-website
- Owner: prabapro
- Created: 2024-01-03T03:26:28.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-02-08T18:06:34.000Z (11 months ago)
- Last Synced: 2024-12-01T08:55:25.637Z (24 days ago)
- Topics: decap-cms, hugo, netlify
- Language: HTML
- Homepage: https://slcfhr.org
- Size: 12.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 SLCFHR
A Jamstack website for Siri Lakxmi Center For Human Rehabilitation (**SLCFHR**).
- **SSG:** [Hugo](https://gohugo.io/)
- **CMS:** [Decap CMS](https://decapcms.org/) (Formerly "Netlify CMS")
- **Deployed on:** [Netlify](https://www.netlify.com/)
## 👨💻 Development Environment
### Environment Variables
- Generate `.env` file from `.env.example` and update your env variables.
```shell
cp .env.example .env
```
- If new keys are added to the `.env` file, run below command to update the example file with new keys.
```shell
sed 's/=.*/=/' .env > .env.example
```
### Local Server
Execute the following command to launch the local server:
```shell
open -a 'Google Chrome Canary.app' http://localhost:1313/ && export $(grep -v '^#' .env | xargs) && hugo server -D --disableFastRender --ignoreCache
```
#### Alternatively, you can set an alias using below steps;
1. Edit your ZSH config using `nano ~/.zshrc`
2. Add below to the ZSH config & run `source ~/.zshrc`
```shell
alias hugo-serve='open -a "Google Chrome Canary.app" http://localhost:1313/ && export $(grep -v "^#" .env | xargs) && hugo server -D --disableFastRender --ignoreCache'
```
3. Restart the terminal & start using the alias `hugo serve`
### Local Build
To perform a local build, use the following command:
```shell
hugo --gc --minify
```
> This is not required as Netlify will handle when publishing the site. But useful when inspecting the content inside the `public` folder.
## 📚 Content Management
### Creating New Content with hugo commands
To create a new blog post, event, or notice, use the respective commands:
```shell
hugo new blog/name-of-the-post.md
```
```shell
hugo new event/name-of-the-event.md
```
```shell
hugo new notice/name-of-the-notice.md
```
## 🧰 Decap CMS
The Decap CMS allows users to add, edit, and delete blogs, events, and notices without granting access to the repository. User accounts are managed by [Netlify Identity](https://docs.netlify.com/security/secure-access-to-sites/identity/).
- [Decap CMS Documentation](https://decapcms.org/docs/hugo/)
### Usage Steps:
1. Invite a user using Netlify Identity (Limit: 5 users).
1. Login to `https://slcfhr.org/admin` using the provided credentials.
1. After making changes and publishing, Decap CMS will automatically generate a Pull Request and delete the branch - [Example](https://github.com/prabapro/slcfhr-hugo-website/pull/2).
1. Run `git pull` on the local repository to sync changes.
### Running Decap Server Locally
To run locally with Decap Server, use the following command:
```shell
npx decap-server
```
1. This command will run the local server on port `8081` without opening a browser window.
1. Now run the `hugo-serve` alias.
1. Open `http://localhost:1313/admin` (no password required).
1. Changes will be made to the local repository.
##  Netlify Deployment
[](https://app.netlify.com/sites/praba-slcfhr/deploys)
Netlify automatically monitors the GitHub repository for changes in the `main` branch. Upon detection of changes, Netlify initiates the build process and publishes updates instantly.
#### ⚠️ Important
Keep the `netlify.toml` file updated if there are changes to the local `hugo version`. Ensure that the version specified in `netlify.toml` matches the one in your local environment before committing changes to the remote repository.
**Example**: when `hugo version` returns
hugo v0.121.2-6d5b44305eaa9d0a157946492a6f319da38de154+extended darwin/arm64 BuildDate=2024-01-05T12:21:15Z VendorInfo=brew
```toml
[build.environment]
HUGO_VERSION = "0.121.2"
```