Start by downloading the repository or by cloning the project: 

git clone https://github.com/jacobxperez/rams.git

Install dependencies on your machine with npm 

npm install

Build

Edit the settings, add custom modules and linked them to index.css for compiling.

  • /css
    • core (important files for compiling)
    • custom (add custom modules here)
    • index.css (compile to produce the final CSS)
    • settings.css (theme settings for fonts, colors, and more)

Compile

On your terminal run these scripts to compile build

  • npm run docs (locally runs documentation)
  • npm run dev (serve current development build)
  • npm run build (makes current build and sets url to "/" can be changed on package.json)

Contributing

If you are interested in contributing to this project, please read our contributing-guidelines.

LICENSE

Copyright (C) 2025 Jacob Perez

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.