Apostrophe Essentials Kit
Apostrophe 3 demo and test project
If you created your project using the CLI tool, all dependencies will already have been installed, so you can skip this step. Otherwise, install
the dependencies using:
Running the project
npm run dev to build the Apostrophe UI and start the site up. Remember, this is during alpha development, so we're all in "dev mode." The
Making it your own
This boilerplate is designed so you can install and start running it right away. If you are starting a project that will go into production one day, there are a few things you should be sure to check:
- Update the shortname. You don't need to perform this step if you created your project using the CLI tool. The
app.jsis used for the database name (unless another is given in the
@apostrophecms/dbmodule). You should change this to an appropriate project name before you start adding any users or content you would like to keep.
- Update the Express.js session secret. The secret is set to
undefinedinitially in the
modules/@apostrophecms/express/index.jsfile. You should update this to a unique string.
- Decide if you want hot reloading on. This boilerplate uses nodemon to restart the app when files are changed. In
modules/@apostrophecms/asset/index.jsthere is an option enabled to refresh the browser on restart. If you like this, do nothing. If you don't, remove the option or set it to
false. The option has no effect when the app is in production.
- Update the
app.js. This option is set for core widget types to provide CSS styling hooks. It is namespaced with
bp-for "boilerplate." You will likely want to update that to match your general CSS class naming practices.
You really want the docs
Right now, all the juicy info is in the A3 docs, so head over there and start reading! This boilerplate project is a fun introduction to the UI, but you'll want to know more to really try it out.