From c79aaac7c3511f36f801ffb30ba94da198490956 Mon Sep 17 00:00:00 2001 From: "Bob Means (BoDonkey)" Date: Fri, 27 Oct 2023 09:36:36 -0400 Subject: [PATCH] Add clarity about installation to README --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 4b6f291..6b5899d 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,36 @@ If you prefer, you can follow [these steps](https://github.com/apostrophecms/sta +## Getting started + +This Starter Kit, also known as a boilerplate project, serves as a template for initiating new projects and is intended for use in two main ways: + +1. **Using Our CLI Tool**: Run our [CLI tool](https://github.com/apostrophecms/cli) to clone this template locally, install its dependencies, and set up an initial admin user. You accomplish this using: + + `apos create --starter=ecommerce` + +2. **Manual Setup**: Manually `git clone` this repository and install its dependencies using `npm install`. Add an initial admin user with `node app @apostrophecms/user:add admin admin`. + +For those who need to create multiple projects with additional base modules, consider [forking this repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) into your organizational or personal GitHub account. Customize it to fit your needs. To use your customized template, run the following CLI command: + + `apos create --starter=` + +Here, `` should be the URL of your forked repository, excluding the `https://github.com/` part. + +**Note: This template is NOT designed to be installed into an existing project.** + +## Running the project + +Run `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 `dev` script will watch for saves in client-side CSS and JavaScript and trigger a build and page refresh if they are detected. It will also restart the app when server-side code is saved. + +## 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 `shortname` option in `app.js` is used for the database name (unless another is given in the `@apostrophecms/db` module). 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 `undefined` initially in the `modules/@apostrophecms/express/index.js` file. 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.js` there 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. + ## Thanks ![Thanks to our partner Corlette](https://static.apostrophecms.com/apostrophecms/starter-kit-ecommerce/images/corllete-thanks.png)