> ## Documentation Index
> Fetch the complete documentation index at: https://mirrorful.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Contributing

> Whether it's big or small, we welcome you!

## Community

Community is core to what makes Mirrorful special. All types of contributions are encouraged and valued. Come join our growing [Slack community](https://join.slack.com/t/mirrorful/shared_invite/zt-1ps2xtxh0-2NaixFfFzSKZbr5gw_AHfA). We promise you'll have fun!

## Bugs and Issues

If you have a bug or an idea, browse the open issues before opening a new one. If you're ready to tackle some open issues, [we've collected some good first issues for you](https://github.com/Mirrorful/mirrorful/contribute).

## Local Development Guide

<Info>
  If you run into an issue, join our [Slack
  community](https://join.slack.com/t/mirrorful/shared_invite/zt-1ps2xtxh0-2NaixFfFzSKZbr5gw_AHfA)
  and we'll help you out!
</Info>

Mirrorful has a `web` app and `server` project. Mirrorful's core logic lives in `packages/core`.

After cloning the repo, we can install all dependencies and run the web app:

```bash
# In project root
cd apps/web; yarn; yarn dev;
```

Before running the server, in a seperate terminal window, you'll need to install `mongodb` and run it in the background:

```bash
# In project root
cd packages/server; brew tap mongodb/brew; brew install mongodb-community@6.0; mongod --dbpath ./db/data
```

Finally, in a separate terminal window, run the Mirrorful server:

```bash
# In project root
cd packages/server; yarn; yarn dev;
```

## How else can I help?

* Star the project

* Tweet about it

* Refer this project in your project's README

* Mention the project at local meetups and tell your friends/colleagues

Got any questions? Please reach out to [alex@mirrorful.io](mailto:alex@mirrorful.io) for more info. Thank you!