<div align="center">
  <br>
  <h1>Forem 🌱</h1>
  <strong>For Empowering Community</strong>
</div>
<br>
<p align="center">
  <a href="https://github.com/forem/forem/actions/workflows/ci.yml">
    <img src="https://github.com/forem/forem/actions/workflows/ci.yml/badge.svg" alt="Build Status">
  </a>
  <a href="https://github.com/forem/forem/actions/workflows/cd.yml">
    <img src="https://github.com/forem/forem/actions/workflows/cd.yml/badge.svg" alt="Build Status">
  </a>
  <img src="https://img.shields.io/github/commit-activity/w/forem/forem" alt="GitHub commit activity">
  <a href="https://github.com/forem/forem/issues?q=is%3Aissue+is%3Aopen+label%3A%22ready+for+dev%22">
    <img src="https://img.shields.io/github/issues/forem/forem/ready for dev" alt="GitHub issues ready for dev">
  </a>
  <a href="https://gitpod.io/#https://github.com/forem/forem">
    <img src="https://img.shields.io/badge/setup-automated-blue?logo=gitpod" alt="GitPod badge">
  </a>
</p>

Welcome to the [Forem](https://forem.com) codebase, the platform that powers
[dev.to](https://dev.to). We are so excited to have you. With your help, we can
build out Forem’s usability, scalability, and stability to better serve our
communities.

## What is Forem?

Forem is open source software for building communities. Communities for your
peers, customers, fanbases, families, friends, and any other time and space
where people need to come together to be part of a collective.
[See our announcement post](https://dev.to/devteam/for-empowering-community-2k6h)
for a high-level overview of what Forem is.

[dev.to](https://dev.to) (or just DEV) is hosted by Forem. It is a community of
software developers who write articles, take part in discussions, and build
their professional profiles. We value supportive and constructive dialogue in
the pursuit of great code and career growth for all members. The ecosystem spans
from beginner to advanced developers, and all are welcome to find their place
within our community. ❤️

## Table of Contents

- [What is Forem?](#what-is-forem)
- [Table of Contents](#table-of-contents)
- [Community](#community)
- [Contributing](#contributing)
- [Getting Started](#getting-started)
- [Installation Documentation](#installation-documentation)
- [Developer Documentation](#developer-documentation)
- [Vulnerability disclosure](#vulnerability-disclosure)
- [Acknowledgements](#acknowledgements)
- [License](#license)

## Community

For a place to have open discussions on features, voice your ideas, or get help
with general questions please visit our community at
[forem.dev](https://forem.dev/).

## Contributing

We encourage you to contribute to Forem! Please check out the
[Contributing to Forem guide](https://developers.forem.com/contributing-guide/forem)
for guidelines about how to proceed.

## Getting Started

This section provides a high-level quick start guide. If you're looking for a
more thorough installation guide (for example
[with macOS](https://developers.forem.com/getting-started/installation/mac),
you'll want to refer to our complete
[Developer Documentation](https://developers.forem.com/).

We run on a [Rails](https://rubyonrails.org/) backend, and we are currently
transitioning to a [Preact](https://preactjs.com/)-first frontend.

A more complete overview of our stack is available in
[our docs](https://developers.forem.com/technical-overview/stack).

To **launch Forem in Gitpod**, navigate to
[https://gitpod.io/#https://github.com/{your_github_username}/forem](https://gitpod.io/#https://github.com/{your_github_username}/forem).

### Installation Documentation

Please see our installation guides:

- [MacOS, without containers](https://developers.forem.com/getting-started/installation/mac)
- [Linux, without containers](https://developers.forem.com/getting-started/installation/linux)

## Developer Documentation

[Check out our dedicated docs page for more technical documentation](https://developers.forem.com).

## Vulnerability disclosure

Forem is the open source software which powers [DEV](https://dev.to).

We welcome security research on DEV under the terms of our
[vulnerability disclosure policy](https://dev.to/security).

## Acknowledgements

Thank you to the [Twemoji project](https://github.com/twitter/twemoji) for the
usage of their emojis.

Thank you to [Uffizzi](https://www.uffizzi.com) for providing ephemeral
environments to preview pull requests.

## License

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version. Please see the [LICENSE](./LICENSE.md) file in our repository for
the full text.

Like many open source projects, we require that contributors provide us with a
Contributor License Agreement (CLA). By submitting code to the Forem project,
you are granting us a right to use that code under the terms of the CLA.

Our version of the CLA was adapted from the Microsoft Contributor License
Agreement, which they generously made available to the public domain under
Creative Commons CC0 1.0 Universal.

Any questions, please refer to our
[license FAQ](https://developers.forem.com/licensing/) doc or email yo@dev.to.

<br>

<p align="center">
  <img alt="Sloan, the sloth mascot" width="250px" src="https://thepracticaldev.s3.amazonaws.com/uploads/user/profile_image/31047/af153cd6-9994-4a68-83f4-8ddf3e13f0bf.jpg">
  <br>
  <strong>Happy Coding</strong> ❤️
</p>

[⬆ Back to Top](#table-of-contents)
