apostrophe

(β˜… 4,603)

A full-featured, open-source content management framework built with Node.js that empowers organizations by combining in-context editing and headless architecture in a full-stack JS environment.

Showing a partial file list β€” download the zip above to see everything.

  • .editorconfig
  • .gitignore
  • .npmrc
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • DEVELOPMENT.md
  • logo.svg
  • MONOREPO.md
  • package.json
  • README.md

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/apostrophecms/apostrophe

Downloads the entire project code from GitHub to your computer.

cd apostrophe

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install -g @apostrophecms/cli

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install -g @apostrophecms/cli

Installs the package published on the npm registry globally β€” no need to clone the source.

npm run dev

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation