search

Visual-Communications / fair-housing-pledge

https://fairhousingpledge.com/
0 stars 0 forks source link

readme

Fair Housing Pledge

Netlify Status JavaScript Style Guide

This client-side JAMstack static website is built with Eleventy, Gulp, PostCSS, and Webpack, and configured for deployment to a CDN via Netlify. It has CI/CD setup - deploy by merging a pull request into the master branch on GitHub.

Sass is linted, transpiled into CSS, post-processed with PostCSS, beautified in development, and minified in production, with source maps. JavaScript is linted, transpiled with Babel, bundled with Webpack, concatenated, and minified in production, with source maps.

FairHousingPledge.com

Quick Start

Requirements

  1. Node
    • Check if Node is installed: node --version
    • If you see a version number, such as v14.2.0, skip the next step
    • If Node isn't installed, download and install it (or use nvm)
  2. Heroku CLI (optional -- only necessary for clearing the Heroku cache, or otherwise interacting with Heroku from the CLI)
    • Check if Heroku CLI is installed: heroku --version
    • If you see a version number, such as heroku/7.42.1 darwin-x64 node-v12.16.2, skip the next step
    • If Heroku CLI isn't installed, download and install it

Get Started

Fork or clone this repo, install dependencies, add environment variables, and start:

# Clone the repo
git clone https://github.com/Visual-Communications/fair-housing-pledge.git
cd fair-housing-pledge

# Install dependencies
npm install

# Add environment variables:
# See ./config/custom-environment-variables.json
# and ./_docs/environment-variables.md
touch ./.env
# The above line will create a new file from scratch,
# OR you can just save a .env file in the root directory,
# if one was provided to you.

# Serve the local server API to localhost:3000 and watch for changes
npm watch:server

# Build the local client site, serve to localhost:8082, and watch for changes
npm serve:client

# Or, on certain machines (namely Windows):
npm run serve:client

Documentation

Project documentation files are in the _docs directory.

Contributing

If you'd like to contribute, please read the Code of Conduct and Contributing instructions, then fork the repository and use a feature branch. Pull requests are welcome.