Skip to content

Commit 7076f18

Browse files
authored
3/new readme (#2689)
* Updates readme * Updates logo link in readme
1 parent 0f96f7e commit 7076f18

File tree

2 files changed

+78
-25
lines changed

2 files changed

+78
-25
lines changed

README.md

+45-25
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,61 @@
1-
# [<img src="./ApostropheCMS_logo.png" height="140" title="ApostropheCMS" />](http://apostrophecms.org/)
21

3-
ApostropheCMS is a content management system (CMS) for Node.js. It supports in-context editing, schema-driven content types, flexible widgets and a great deal more. This module contains everything necessary to build a website with ApostropheCMS.
2+
[![CircleCI](https://circleci.com/gh/apostrophecms/apostrophe/tree/3.0.svg?style=svg)](https://circleci.com/gh/apostrophecms/apostrophe/tree/3.0)
3+
[![Chat on Discord](https://img.shields.io/discord/517772094482677790.svg)](https://chat.apostrophecms.org)
44

5-
Please see the [ApostropheCMS documentation](http://apostrophecms.org/docs) for detailed information about building sites with ApostropheCMS.
5+
<p align="center">
6+
<a href="https://github.com/apostrophecms/apostrophe">
7+
<img src="logo.svg" alt="ApostropheCMS logo" width="80" height="80">
8+
</a>
69

7-
[![TravisCI Status](https://travis-ci.org/apostrophecms/apostrophe.svg?branch=master)](https://travis-ci.org/apostrophecms/apostrophe)
8-
[![Build Status](https://saucelabs.com/buildstatus/boutell)](https://saucelabs.com/beta/builds/1681358095414ff5b2b0ce51a6def56e)
9-
[![Join the chat at https://gitter.im/apostrophecms/apostrophe](https://badges.gitter.im/apostrophecms/apostrophe.svg)](https://gitter.im/apostrophecms/apostrophe?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
10+
<h3 align="center">ApostropheCMS 3</h3>
1011

11-
## Getting Started
12+
<p align="center">
13+
ApostropheCMS is a full-featured, open source CMS built with Node.js that seeks to empower organizations by combining in-context editing and headless architecture in a full-stack JS environment.
14+
<br />
15+
<a href="https://a3.docs.apos.dev/"><strong>Alpha Documentation »</strong></a>
16+
<br />
17+
<br />
18+
<a href="https://demo.apos3.dev">A3 Demo</a>
19+
·
20+
<a href="https://portal.productboard.com/apostrophecms/1-product-roadmap/tabs/2-planned">Roadmap</a>
21+
·
22+
<a href="https://github.com/apostrophecms/apostrophe/issues/new?assignees=&labels=bug,3.0&template=bug_report.md&title=">Report Bug</a>
23+
</p>
24+
</p>
25+
26+
## About ApostropheCMS
27+
28+
ApostropheCMS is content software for everyone in an organization. It helps teams of all sizes create dynamic digital experiences with elegance and efficiency by blending powerful features, developer happiness, and a low learning curve for content creators. Apostrophe has powered websites and web apps for organizations large and small for over a decade.
1229

13-
The [ApostropheCMS documentation](http://apostrophecms.org/docs/tutorials/getting-started/index.html) will walk you through some simple steps to get your [local environment set up](http://apostrophecms.org/docs/tutorials/getting-started/setting-up-your-environment.html) with the technology stack that runs ApostropheCMS (Node.js, MongoDB, ImageMagick) along with installing ApostropheCMS itself.
30+
#### Built With
1431

15-
Then [create a new project](http://apostrophecms.org/docs/tutorials/getting-started/creating-your-first-project.html) on your computer and work on building your beautiful website.
32+
* [Node](https://nodejs.org/en/)
33+
* [MongoDB](https://www.mongodb.com/)
34+
* [Nunjucks](https://mozilla.github.io/nunjucks/)
1635

17-
The ApostropheCMS documentation will walk you through [editing page templates](http://apostrophecms.org/docs/tutorials/getting-started/editing-page-templates.html), [global content](http://apostrophecms.org/docs/tutorials/getting-started/global.html), [creating custom widgets](http://apostrophecms.org/docs/tutorials/getting-started/custom-widgets.html) and [navigation](http://apostrophecms.org/docs/tutorials/getting-started/building-navigation.html), along with [configuring reusable "pieces"](http://apostrophecms.org/docs/tutorials/getting-started/reusable-content-with-pieces.html) and [global settings](http://apostrophecms.org/docs/tutorials/getting-started/settings.html). Plus, a whole lot more!
36+
## Getting Started
37+
38+
To get started with Apostrophe 3, follow these steps to set up a local development environment. For more detail, refer to the [A3 getting started guide](https://a3.docs.apos.dev/guide/starting-your-project.html) in the documentation.
1839

19-
## Taking it Further
40+
#### Prerequisites
2041

21-
Our documentation also covers advanced topics such as [managing permissions](http://apostrophecms.org/docs/tutorials/intermediate/permissions.html), [working with ApostropheCMS data](http://apostrophecms.org/docs/tutorials/intermediate/model-layer.html), [building forms](http://apostrophecms.org/docs/tutorials/intermediate/forms.html), and [hosting an ApostropheCMS site in production](http://apostrophecms.org/docs/tutorials/intermediate/deployment.html).
42+
We recommend installing the following with [Homebrew](https://brew.sh/) on macOS. If you're on Linux, you should use your package manager (apt or yum). If you're on Windows, we recommend the Windows Subsystem for Linux.
2243

23-
Moreover, there's tons of great info in the ["How To"](http://apostrophecms.org/docs/tutorials/howtos/index.html) section of the docs, and it's always growing!
44+
| Software | Minimum Version | Notes
45+
| ------------- | ------------- | -----
46+
| Node.js | 10.x | Or better
47+
| npm | 6.x | Or better
48+
| MongoDB | 3.6 | Or better
49+
| Imagemagick | Any | Faster image uploads, GIF support (optional)
2450

25-
## Extending the Core with Modules
51+
## Community
2652

27-
ApostropheCMS is Node.js all the way through, which means it can be [extended](http://apostrophecms.org/extend) in all sorts of interesting ways. Here's a list of some of our favorite modules:
53+
[Discord](https://discord.com/invite/XkbRNq7) - [Twitter](https://twitter.com/apostrophecms) - [Discussions](https://github.com/apostrophecms/apostrophe/discussions)
2854

29-
* [apostrophe-headless](https://github.com/punkave/apostrophe-headless) - Add REST APIs and power your React / Vue / Native / etc. apps with a headless CMS.
30-
* [apostrophe-blog](https://github.com/punkave/apostrophe-blog) - Everything you need to put a blog on your site.
31-
* [apostrophe-events](https://github.com/punkave/apostrophe-events) - Manage upcoming events.
32-
* [apostrophe-workflow](https://github.com/punkave/apostrophe-workflow) - Add powerful localization capabilities to your project.
33-
* [apostrophe-passport](https://github.com/punkave/apostrophe-passport) - Authenticate via Twitter, Facebook, Github and more.
34-
* [apostrophe-places](https://github.com/punkave/apostrophe-places) - Manage geotagged content and display it on a map.
35-
* [apostrophe-redirects](https://github.com/punkave/apostrophe-redirects) - An easy redirects module.
55+
## Contributing
3656

37-
## Additional Resources
38-
We've got some great [open-source projects](http://apostrophecms.org/docs/tutorials/intermediate/deployment.html) that can help you out deploying, managing and maintaining ApostropheCMS sites.
57+
We eagerly welcome open source contributions. Before submitting a PR, please read through our [Contribution Guide](https://github.com/apostrophecms/apostrophe/blob/main/CONTRIBUTING.md)
3958

4059
## License
41-
ApostropheCMS is released under the [MIT License](https://github.com/punkave/apostrophe/blob/master/LICENSE.md).
60+
61+
ApostropheCMS is released under the [ MIT License](https://github.com/apostrophecms/apostrophe/blob/main/LICENSE.md).

logo.svg

+33
Loading

0 commit comments

Comments
 (0)