Muskoka District Rentals is a Progressive Web Application for renting properties in the Muskoka district of Canada.
Muskoka District Rentals is built using the GatsbyJS framework, and uses Zeit Now for deployments.
The following components are required to run the project (tested on Arch Linux):
node --version
.). If you have a different version use
nvm to install version 11.14.0.git clone git@github.com:the-mmm-agency/muskoka-district-rentals
.cd muskoka-district-rentals
.npm install
to install dependencies.npm start
.http://localhost:8000
.Gatsby exposes the GraphQL playground at
http://localhost:8000/___graphql
. For more information refer to the
GatsbyJS Docs.
If you wish to run Muskoka with ssl enabled use npm run develop:ssl
Gatsby
takes care of generating the certificates.
To verify that everything is working properly you can run the project's tests.
Install the projects dependencies with npm install
.
npm run build
.Unit tests can be run with npm test
.
npm test
with
npm run test:watch
.npm run test:e2e:dev
.npm run test:e2e:run
.Other npm scripts not mentioned above.
npm run format
formats the code with Prettier.npm run lint
runs code linting with Eslint.npm run lint:fix
runs code linting with Eslint.
Attempting to automatically fix issues.npm run lint:styles
lints styled-components
templates with stylelint.npm run lint:styles:fix
lints
styled-components templates with
stylelint. Attempting to automatically fix issues.npm run serve
serves a static build built with npm run build
.