https://github.com/WorldBank-Transport/ram

Rural Accessibility Map Documentation
https://github.com/WorldBank-Transport/ram

Last synced: 18 days ago
JSON representation

Rural Accessibility Map Documentation

• Host: GitHub
• URL: https://github.com/WorldBank-Transport/ram
• Owner: WorldBank-Transport
• License: mit
• Created: 2017-07-31T15:08:40.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-07-07T07:01:09.000Z (over 2 years ago)
• Last Synced: 2024-08-01T00:39:38.568Z (3 months ago)
• Language: CSS
• Homepage: http://ruralaccess.info
• Size: 1.59 MB
• Stars: 13
• Watchers: 6
• Forks: 4
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
RAM Docs


## Installation and Usage

The steps below will walk you through setting up RAM Docs. To install RAM itself, head over to the [ram-backend repository](https://github.com/WorldBank-Transport/ram-backend)!

### Install Project Dependencies

To set up the development environment for this website, you'll need to install the following on your system:

- [Node](http://nodejs.org/) v6 (To manage multiple node versions we recommend [nvm](https://github.com/creationix/nvm))

- [Yarn](https://yarnpkg.com/) Package manager

### Install Application Dependencies

If you use [`nvm`](https://github.com/creationix/nvm), activate the desired Node version:

```

nvm install

```

Install Node modules:

```

yarn install

```

### Usage

#### Config files

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.js`

  - `production.js`

The `production.js` file serves as base and the other 2 will override it as needed:

  - `staging.js` will be loaded whenever the env variable `DS_ENV` is set to staging.

  - `local.js` will be loaded if it exists.

The following options must be set: (The used file will depend on the context):

Example:

```

module.exports = {

};

```

#### Starting the app

```

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.

# Deployment

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.