Santa for Monica

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Acknowledgements

About The Project

A mobile app to manage your Monica account on the go.
This is a WIP app with limited functionality. Get in touch if you think you can help.

Built With

• Flutter

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Dart

brew install dart

Installation

1. Clone the repo

git clone https://github.com/dangilbert/monica.git

2. Install Correct flutter version (Currently using 1.12.13+hotfix.5)

fvm install stable
fvm use stable

3. Run the project

./fvm run

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

As a developer

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

As a translator

Do as above, but check out the localization.csv file where you can provide new languages/translations in a pull request.

License

Distributed under the MIT License. See LICENSE for more information.

**Output:**
````markdown
<!-- PROJECT LOGO -->
<br />
<p align="center">
  <a href="https://github.com/dangilbert/monica">
    <img src="documentation/images/icon.png" alt="Logo" width="80" height="80">
  </a>

  <h3 align="center">Santa for Monica</h3>

  <p align="center">
    <a href="https://codecov.io/gh/dangilbert/monica">
  <img src="https://codecov.io/gh/dangilbert/monica/branch/master/graph/badge.svg" />
</a>
  <a href="https://www.codacy.com/manual/dangilbert/monica?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=dangilbert/monica&amp;utm_campaign=Badge_Grade">
    <img src="https://api.codacy.com/project/badge/Grade/b297d518857249c09da822237325c434" />
  </a>
<a href="https://github.com/dangilbert/monica/actions">
  <img src="https://github.com/dangilbert/monica/workflows/master/badge.svg">
</a>
  <a href="https://github.com/dangilbert/monica/actions">
  <img src="https://github.com/dangilbert/monica/workflows/Deploy%20tagged%20build/badge.svg">
</a>
    <br />
    <a href="https://github.com/dangilbert/monica/issues">Report Bug</a>
    ·
    <a href="https://github.com/dangilbert/monica/issues">Request Feature</a>
  </p>
</p>

<!-- TABLE OF CONTENTS -->

## Table of Contents

- [About the Project](#about-the-project)
  - [Built With](#built-with)
- [Getting Started](#getting-started)
  - [Prerequisites](#prerequisites)
  - [Installation](#installation)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgements](#acknowledgements)

<!-- ABOUT THE PROJECT -->

## About The Project

A mobile app to manage your [Monica](https://github.com/monicahq/monicahq) account on the go.  
This is a WIP app with limited functionality. Get in touch if you think you can help.

### Built With

- [Flutter](https://github.com/flutter/flutter)

<!-- GETTING STARTED -->

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

- Dart

```sh
brew install dart
```

### Installation

1. Clone the repo

```sh
git clone https://github.com/dangilbert/monica.git
```

2. Install Correct flutter version (Currently using 1.12.13+hotfix.5)

```sh
fvm install stable
fvm use stable
```

3. Run the project

```sh
./fvm run
```

<!-- ROADMAP -->

## Roadmap

See the [open issues](https://github.com/dangilbert/monica/issues) for a list of proposed features (and known issues).

<!-- CONTRIBUTING -->

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

### As a developer

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

### As a translator

Do as above, but check out the [localization.csv](localization.csv) file where you can provide new languages/translations in a pull request.

<!-- LICENSE -->

## License

Distributed under the MIT License. See `LICENSE` for more information.