dontfile/dontfile

<p align="center">
  <img style="text-align:center;" src="public/dontfile.png" width=150 height=150>
  <h3 align="center">Dontfile</h3>
</p>

<p align="center">
  <i>The dontpad of files</i>
  <br>
  <br>
  <a href="https://travis-ci.org/dontfile/dontfile">
    <img src="https://travis-ci.org/dontfile/dontfile.svg?branch=master" alt="Build Status">
  </a>
  <a href="https://codeclimate.com/github/dontfile/dontfile/maintainability">
    <img src="https://api.codeclimate.com/v1/badges/786863e9b71eab0a50e9/maintainability" alt="Maintainability">
  </a>
  <a href="https://codeclimate.com/github/dontfile/dontfile/test_coverage">
    <img src="https://api.codeclimate.com/v1/badges/786863e9b71eab0a50e9/test_coverage" alt="Test Coverage">
  </a>
  <a href="https://github.com/dontfile/dontfile/blob/master/LICENSE">
    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
  </a>
</p>

Dontfile is an open source website to store and share text and files (up to 100MB) using URL paths. It continuously saves data as you type. Hosted at http://dontfile.com.

## Tech/Framework used

Dontfile is built with [Ruby](https://www.ruby-lang.org/en/) language with the [Ruby on Rails](https://rubyonrails.org/) web framework

## Features

- Collaboration using URLs
- Text saved automatically
- File storage

## Installation

### Local installation

#### Prerequisites

- Ruby version: 2.6.5
- Rails version: 6.0.1

#### Install latest bundler

Install [bundler](https://bundler.io/)

```bash
gem install bundler
```

#### Bundle the necessary gems

```bash
bundle install
```

#### Create the database

```bash
rails db:create
```

#### Migrate the database

```bash
rails db:migrate
```

#### Run the server

```bash
rails server
```

### Docker

#### Prerequisites for docker

- [Docker](https://docs.docker.com/install/)
- [Docker Compose](https://docs.docker.com/compose/install/)

#### Steps

Run docker compose

```bash
docker-compose up -d
```

Navigate to http://localhost:3000

## Tests

```bash
rails test
```

## Contribute
Did you find a bug or want to contribute to Dontfile? See [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on how to get started.

## Credits

Dontfile was inspired by [dontpad](http://dontpad.com) philosophy.

## License
Dontfile is under the [MIT License](LICENSE)! You can download, change and share the source code!

MIT © [Matheus Richard](https://github.com/MatheusRich)