{"id":18561190,"url":"https://github.com/apostrophecms/starter-kit-essentials","last_synced_at":"2025-04-10T02:31:27.177Z","repository":{"id":39583625,"uuid":"309222604","full_name":"apostrophecms/starter-kit-essentials","owner":"apostrophecms","description":"Simple, minimal starting point for new ApostropheCMS projects","archived":false,"fork":false,"pushed_at":"2025-03-31T12:22:36.000Z","size":262,"stargazers_count":11,"open_issues_count":7,"forks_count":19,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-03T05:30:04.346Z","etag":null,"topics":["a3-starter-kit"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apostrophecms.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-02T01:01:38.000Z","updated_at":"2025-03-31T12:22:40.000Z","dependencies_parsed_at":"2023-10-26T10:37:48.291Z","dependency_job_id":"fe382a58-d387-486d-94eb-529f6afece8e","html_url":"https://github.com/apostrophecms/starter-kit-essentials","commit_stats":null,"previous_names":["apostrophecms/starter-kit-essentials","apostrophecms/a3-boilerplate"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apostrophecms%2Fstarter-kit-essentials","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apostrophecms%2Fstarter-kit-essentials/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apostrophecms%2Fstarter-kit-essentials/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apostrophecms%2Fstarter-kit-essentials/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apostrophecms","download_url":"https://codeload.github.com/apostrophecms/starter-kit-essentials/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248144205,"owners_count":21054885,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["a3-starter-kit"],"created_at":"2024-11-06T22:06:05.726Z","updated_at":"2025-04-10T02:31:26.769Z","avatar_url":"https://github.com/apostrophecms.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ApostropheCMS essentials starter kit\n\n## Getting started\n\nThis 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:\n\n1. **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:\n   \n   `apos create \u003cmy-project-name\u003e`\n  \n2. **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`.\n\nFor 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:\n\n  `apos create \u003cproject-name\u003e --starter=\u003crepo-name\u003e`\n\nHere, `\u003crepo-name\u003e` should be the URL of your forked repository, excluding the `https://github.com/` part.\n\n**Note: This template is NOT designed to be installed into an existing project.**\n\n## Running the project\n\nRun `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.\n\n## Making it your own\n\nThis 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:\n\n- [ ] **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.\n- [ ] **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.\n- [ ] **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.\n- [ ] **Update the `className` options in `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.\n\n## You really want the docs\n\nRight now, [all the juicy info is in the ApostropheCMS docs](https://docs.apostrophecms.org), 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.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapostrophecms%2Fstarter-kit-essentials","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapostrophecms%2Fstarter-kit-essentials","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapostrophecms%2Fstarter-kit-essentials/lists"}