The steps below will walk you through setting up RAM Docs. To install RAM itself, head over to the ram-backend repository!
To set up the development environment for this website, you'll need to install the following on your system:
If you use nvm, activate the desired Node version:
nvm install
Install Node modules:
yarn install
All the config files can be found in app/assets/scripts/config.
After installing the projects there will be 3 main files:
local.js- Used only for local development. On production this file should not exist or be empty.staging.jsproduction.js
The production.js file serves as base and the other 2 will override it as needed:
staging.jswill be loaded whenever the env variableDS_ENVis set to staging.local.jswill be loaded if it exists.
The following options must be set: (The used file will depend on the context):
Example:
module.exports = {
};
yarn run serve
Compiles the sass files, javascript, and launches the server making the site available at http://localhost:3000/
The system will watch files and execute tasks whenever one of them changes.
The site will automatically refresh since it is bundled with livereload.
To prepare the app for deployment run:
yarn run build
This will package the app and place all the contents in the dist directory.
The app can then be run by any web server.