state-hiu / Mapgive

MapGive dev site
https://state-hiu.github.io/Mapgive
MIT License
7 stars 11 forks source link

MapGive

Description

This repository contains the contents of the MapGive website accessible at https://mapgive.state.gov.

Installation

These installation instructions are subject to change.

Jekyll (https://jekyllrb.com/) needs to be installed.

Now you can run the commands below to install the other dependencies:

sudo apt-get install npm
sudo apt-get install nodejs
sudo ln -s /usr/bin/nodejs /usr/bin/node #grunt expects "node"

sudo npm install -g grunt-cli
sudo apt-get install optipng
sudo apt-get install libjpeg-progs

Navigate to the Mapgive directory. The first time run 'npm install' to install the grunt dependencies. Also run 'bundle install' to install the ruby dependencies from the gem file.

Usage

From now on you can build the site by running the 'grunt' command inside of the Mapgive directory. Grunt outputs the site in the '_site' folder. You can also run the site locally by running 'jekyll serve'.

Contributing

HIU is currently accepting pull requests for this repository. Please provide a human-readable description of the changes in the pull request. Additionally, update the README.md file as needed.

License

This project constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105.

However, because the project utilizes code licensed from contributors and other third parties, it therefore is licensed under the MIT License. http://opensource.org/licenses/mit-license.php. Under that license, permission is granted free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the conditions that any appropriate copyright notices and this permission notice are included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.