https://github.com/modulojs/modulo-jamstack-deploy
One-click deploy for Modulo Jamstack: A minimalist SSG with Decap / Netlify CMS and Markdown support
https://github.com/modulojs/modulo-jamstack-deploy
Last synced: 2 months ago
JSON representation
One-click deploy for Modulo Jamstack: A minimalist SSG with Decap / Netlify CMS and Markdown support
- Host: GitHub
- URL: https://github.com/modulojs/modulo-jamstack-deploy
- Owner: modulojs
- Created: 2023-09-15T19:29:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-15T19:36:52.000Z (over 2 years ago)
- Last Synced: 2024-11-16T19:18:44.144Z (about 1 year ago)
- Language: JavaScript
- Size: 37.1 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go to for the latest Modulo version and documentation
This is a Modulo.js website created with `create-modulo`
-----------
## One-click Deploy
### Netlify Host
[](https://app.netlify.com/start/deploy?repository=https://github.com/modulo/modulo-jamstack-deploy)
----
# Template Details
This template has Netlify's Decap CMS ready to go. This allows you and your
teammates to upload content and commit changes with a rich text editor, without
any coding or git knowledge. More info:
## Usage
### Relevant files to edit
- You will mostly work in the `src/` directory
- Edit the Markdown files in `src/articles/` to add article or blog-style
content (also editable by CMS, see below)
- Edit the files in `src/static/` to work on the CSS, JS, and HTML Templates
that create Modulo Components (including the "x-Page" layout template)
- Edit the files in `src/static/data/links/` to change the ordering or content
of the page navigation or article link list (also editable by CMS, see below)
### Using local server and CMS
Use the following commands:
- `npm start`
- Starts a simple HTTP server for testing:
- `npm run startcms`
- Runs proxy for Decap CMS:
- This is intended for local content editing (it is NOT a live, public site)
- Note: Run this at the same time as `npm start` (e.g. in another terminal)
- `npm run build`
- Generates static site build locally in `build/` directory
- Useful for testing server-side rendering
- Note: This requires dependencies. It runs `npm install modulocli` first.
## Publishing checklist
Launch your site on any web server that can host static sites, ideally one that
can run a "build step" before serving for "server-side rendering".
* [X] netlify.toml is already specified!
* [ ] To publish, make sure your web-host is configured to run `npm run build`
when code is updated, and serve the `build` directory. Some might work with
minimal configuration, otherwise you may have to manually build locally.
* [ ] To enable the CMS on the remote server, you will need to reconfigure
Decap CMS to work with whatever authentication system you want to use. The
Decap CMS is by the Netlify web-hosting service, which recommends use of
GitHub (among others) as an authenticator. Read more on configuring this:
* [ ] **Replace this README with one specific to your project!**