Safe Paths

A new look for https://covidsafepaths.org

Website: https://covidsafepaths.org/
Netlify Admin: https://app.netlify.com/sites/safepaths/settings/general

📜 About

Pages are authored in HTML or, optionally, Twig and live in the src/pages directory.
Twig templates and partials live in src/templates.
Site data files live in src/data. Drop any .json, .yml, or .js file exporting a function into this directory and access the resulting data in Twig templates using {{ site.data['path/to/file.ext'] }}. Powered by Puppy.
Styles are authored with Sass and live in src/scss.
Javascripts live in src/js. They are transipiled at build time with Babel so that they can take advantage of modern JS syntax
Any files in the public directory are copied to the web root recursively at build time.
Static assets are bundled at build time using Webpack.
All source assets are pulled together with Gulp and used to generate a static site in the dist directory.

✨ Install

# Install Node & NPM with [NVM](https://github.com/nvm-sh/nvm)
nvm install

# Install project dependencies
npm install

👩‍💻 Usage

Development

# Start a local dev server
npm start

# Check for JS/SCSS style violations prior to commit
npm run lint

# Fix the fixable linter violations
npm run lint:fix

# Format code with Prettier
npm run format

Production

# Build for production
npm run build

# Serve locally using `serve`
npx serve dist

Deployment

This site is hosted on Netlify.

Deployments to https://covidsafepaths.org/ are triggered automatically by commits to the master branch via their GitHub App.

Running in a Docker container

To be able to run the the Safe-Places Web tool in a container follow the following steps.

Build Container :

docker build -t safeplaces-web:latest

Run Conatiner :

docker run --rm --name safeplaces -it -p 8080:3000 safeplaces-web:latest

Open you browser and load the url http://localhost:8080

Docker env variables:

PORT=3000
NODE_ENV=development

A Puppy 🐶 powered project

bcui6611/safepaths-website