steve
/
sunrise-cms
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

documentation

pull/11/head
Dan Gowans 2025-04-15 13:36:18 -04:00
parent 3312f70967
commit f652f27c5e
2 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -18,6 +18,8 @@ This is a major refactoring of the now archived
originally built with multiple focuses in mind. This fork completely reworks the project originally built with multiple focuses in mind. This fork completely reworks the project
to focus exculsively on cemetery management. to focus exculsively on cemetery management.
[**User Documentation (In the Works)**](./docs/README.md)
## Why Sunrise CMS? ## Why Sunrise CMS?
### ✔️ Cemetery Maps are NOT Required ### ✔️ Cemetery Maps are NOT Required
@ -46,6 +48,7 @@ There's no cost to use it.
## About this Project ## About this Project
- 📘 [Documentation](./docs/README.md)
- 🤗 [Code of Conduct](CODE_OF_CONDUCT.md) - 🤗 [Code of Conduct](CODE_OF_CONDUCT.md)
- 🥰 [Contributing Guidelines](CONTRIBUTING.md) - 🥰 [Contributing Guidelines](CONTRIBUTING.md)
- 🛡️ [Security Policy](SECURITY.md) - 🛡️ [Security Policy](SECURITY.md)
@ -54,3 +57,13 @@ There's no cost to use it.
Although the system is quite niche, it's being released in an open source environment in hopes to pool developer resources from other municipalities looking to move away from older, legacy systems. Although the system is quite niche, it's being released in an open source environment in hopes to pool developer resources from other municipalities looking to move away from older, legacy systems.
It is being shared to start the dialog among other municipalities and present an option to those who may be looking to refresh their own cemetery systems. It is being shared to start the dialog among other municipalities and present an option to those who may be looking to refresh their own cemetery systems.
## More City Management Applications from the City of Sault Ste. Marie
[**General Licence Manager**](https://cityssm.github.io/general-licence-manager/)<br />
An application built to manage the general licences issued by municipalities.
[**Attendance Tracking**](https://cityssm.github.io/attendance-tracking/)<br />
Track employee absences, call outs, and more.
💡 Discover even more on [the City of Sault Ste. Marie's GitHub page](https://cityssm.github.io/).

5
docs/installation.md
View File

@ -15,13 +15,13 @@ which is able to run on budget hardware.
_More is better_, however under stress tests, _More is better_, however under stress tests,
the application peaked at the following: the application peaked at the following:
- 2 GB of RAM - 512 MB of RAM
- 1 GB of storage for application, dependencies, and data. - 1 GB of storage for application, dependencies, and data.
## Step 1: Install Node.js 18 or better and npm ## Step 1: Install Node.js 18 or better and npm
[Node.js](https://nodejs.org) is a JavaScript runtime environment. [Node.js](https://nodejs.org) is a JavaScript runtime environment.
Sunrise CMS is built to run on Node.js. Sunrise CMS is built to run on Node.js, and is regularly tested on the currently supported LTS versions.
[npm](https://www.npmjs.com/) is a package manager that contains all the prerequisites [npm](https://www.npmjs.com/) is a package manager that contains all the prerequisites
for Sunrise CMS. for Sunrise CMS.
@ -82,5 +82,4 @@ The included `windowsService-install.bat` script simplifies
the process of keeping the application running in a Windows environment the process of keeping the application running in a Windows environment
by creating a service that can start with the hosting server. by creating a service that can start with the hosting server.
> npm link node-windows
> windowsService-install > windowsService-install