README.md 1.55 KB
Newer Older
Bat's avatar
Bat committed
1
2
3
# Plume

A federated blogging application, inspired by Medium, but based on ActivityPub.
Bat's avatar
Bat committed
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

This project is powered by [Amber Framework](https://amberframework.org/).

## Installation

1. [Install required dependencies](https://github.com/amberframework/online-docs/blob/master/getting-started/quickstart/zero-to-deploy.md#install-crystal-and-amber)
2. Run `shards install`

## Usage

To setup your database edit `database_url` inside `config/environments/development.yml` file.

To edit your production settings use `amber encrypt`. [See encrypt command guide](https://github.com/amberframework/online-docs/blob/master/getting-started/cli/encrypt.md#encrypt-command)

To run amber server in a **development** enviroment:

```
amber db create migrate
amber watch
```

To build and run a **production** release:

1. Add an environment variable `AMBER_ENV` with a value of `production`
2. Run these commands:

```
npm run release
amber db create migrate
shards build --production
./bin/plume
```

## Docker Compose

To set up the database and launch the server:

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

To view the logs:

```
docker-compose logs -f
```

> **Note:** The Docker images are compatible with Heroku.

## Contributing

Bat's avatar
Bat committed
55
1. Fork it ( https://github.com/BaptisteGelez/plume/fork )
Bat's avatar
Bat committed
56
57
58
59
60
61
62
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

## Contributors

Bat's avatar
Bat committed
63
- [BaptisteGelez](https://github.com/BaptisteGelez) Baptiste Gelez - creator, maintainer