0.3.5 • Published 5 years ago

vapid-cli v0.3.5

Weekly downloads
122
License
MIT
Repository
github
Last release
5 years ago

Vapid is an intentionally simple content management system built on the idea that you can create a custom dashboard without ever leaving the HTML.

CircleCI

Installation

Vapid requires node v8.9.0 or higher, and can be installed via npm

npm install -g vapid-cli

Note: A desktop GUI application is coming soon—please add yourself to the mailing list if you'd like to be notified when that is available.

Usage

To create a new website project, use the Vapid command line tool:

vapid new path/to/project/folder

Then change to the project directory, and start the development server. By default, the server will livereload, and refresh your website as you change the source files.

cd path/to/project/folder
vapid start .

A few files and folders you should be aware of:

File/FolderDescription
wwwYour website files. Anything you put in here is an accessible resource, with the exceptions of files that start with underscores or periods—those are private/special. Sass and JS files that have the .pack.js, .pack.scss, or .pack.sass extensions will be compiled by Webpack.
dataSQLite database file, and uploaded images. In general, you do not want to mess with this folder.
node_modulesThis one should also be ignored.
package.jsonInformation about your project, including Vapid configuration options.
.envA private file that contains server environment variables, like the SECRET_KEY used by the web server.

Deploying

Vapid can be deployed to any hosting service that supports Node.js. Here are a few to consider:

ServiceNotes
VapidZero-config service that can be accessed via the vapid deploy command. Note: it is currently in private beta.
HerokuFree or paid tiers. One thing to note is that Heroku's file system is ephemeral, so Vapid's type=image directives won't work here.
GlitchThe easiest way to take Vapid for a test-drive.

Community

If you'd like to get involved, and help improve Vapid:

License

MIT