simple-netlify
v0.3.1
Published
A simple development server for Netlify sites
Downloads
5
Maintainers
Readme
Simple Netlify
A simple development server CLI for Netlify sites. Because netlify dev
does too much and is very involved if all you want is to serve some html files.
- Handles basic redirect rules from a
_redirects
file - Serves the
publish
directory from anetlify.toml
file - Runs the
command
from anetlify.toml
file - Handles & serves js
functions
directory from anetlify.toml
file
This package is very basic. If you need the full power of Netlify, use netlify dev
from their official CLI.
How to use
Install as a dev dependency in your project
yarn add --dev simple-netlify
Run it
simple-netlify
It will use the properties set in a netlify.toml
file if you have one, either from the [dev]
section or falling back to the [build]
section.
You can also override it with your own directory or commands:
simple-netlify --publish dist
# or
simple-netlify -p dist
simple-netlify --command "yarn dev"
# or
simple-netlify -c "yarn dev"
simple-netlify --functions functions
# or
simple-netlify -f functions
Issues
If you find any bugs or missing features, feel free to open an issue.
Contributing
I welcome pull requests to fix bugs, add features and more. Feel free to fork the repository and work on it, but don't forget to open an issue to discuss the changes you intend to make before submitting your PR.
See the contributing guide for more information.