mirror of
https://github.com/bonfire-networks/bonfire-app.git
synced 2024-05-09 20:52:38 +00:00
docs
This commit is contained in:
Mayel de Borniol
parent
44eb4a0009
commit
7e2aa1d47a
2
Makefile
2
Makefile
|
|
@ -142,7 +142,7 @@ db.rollback.all: mix~"ecto.rollback --all" ## Rollback ALL DB migrations (cautio
|
|||
|
||||
#### UPDATE COMMANDS ####
|
||||
|
||||
update: init update.repo update.app build update.forks mix~deps.get mix~ecto.migrate js.deps.get ## Update the dev app and all dependencies/extensions/forks, and run migrations
|
||||
update: init update.repo build update.forks update.deps mix~deps.get mix~ecto.migrate js.deps.get update.repo ## Update the dev app and all dependencies/extensions/forks, and run migrations
|
||||
|
||||
update.app: update.repo update.deps ## Update the app and Bonfire extensions in ./deps
|
||||
|
||||
|
|
|
|||
|
|
@ -16,49 +16,31 @@ Bonfire is currently alpha software. While it's fun to play with it,
|
|||
we would *absolutely not* recommend running any production instances
|
||||
yet because it's just not ready for that today.
|
||||
|
||||
<<<<<<< Updated upstream
|
||||
Either way, you need to first clone this repository and change into the directory and then do some configuration:
|
||||
The team is working hard on a beta release of bonfire social (classic flavour)
|
||||
which should be ready in Q1 2022. Other flavours/apps will probably lag
|
||||
behind for a while and may not always build cleanly. We recommend
|
||||
sticking with bonfire social (aka the 'classic' flavour) for now.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Picking a flavour
|
||||
|
||||
Bonfire is a flexible platform that powers a variety of social networks. The first thing you have to choose is which app (or "flavour") you want to hack on:
|
||||
|
||||
For example if you want to run the `classic` flavour:
|
||||
|
||||
`export FLAVOUR=classic`
|
||||
|
||||
### Initialise
|
||||
|
||||
Yu need to clone this repository and change into the directory and then do some configuration:
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/bonfire-networks/bonfire-app.git bonfire
|
||||
$ cd bonfire
|
||||
```
|
||||
=======
|
||||
The team is working hard on a beta release of bonfire social which
|
||||
should be ready in Q1 2022. Other flavours/apps will probably lag
|
||||
behind for a while and may not always build cleanly. We recommend
|
||||
sticking with bonfire social (aka the 'classic' flavour) for now.
|
||||
>>>>>>> Stashed changes
|
||||
|
||||
<!-- ## Picking a flavour -->
|
||||
|
||||
<!-- Bonfire is a flexible platform that powers a variety of social -->
|
||||
<!-- networks. The first thing you have to choose is which app (or -->
|
||||
<!-- "flavour") you want to hack on: -->
|
||||
|
||||
<<<<<<< Updated upstream
|
||||
For example if you want to run the `cooperation` flavour:
|
||||
|
||||
`export FLAVOUR=cooperation`
|
||||
=======
|
||||
<!-- * Classic ("Bonfire Social", a toot-based social network that interoperates with the fediverse) -->
|
||||
<!-- * Cooperation (for building cooperative communities) -->
|
||||
<!-- * Reflow (for community economic activities) -->
|
||||
<!-- * Haha (for learning new things) -->
|
||||
|
||||
<!-- Note that at the current time, the core team are focusing most of -->
|
||||
<!-- their efforts on the classic flavour and this is where we recommend you start. -->
|
||||
>>>>>>> Stashed changes
|
||||
|
||||
## Configuration
|
||||
|
||||
<!-- If you want to hack on another flavour than 'classic' (not recommended -->
|
||||
<!-- right now), you must export it in the environment. For example if you -->
|
||||
<!-- want to run the `cooperation` flavour: -->
|
||||
|
||||
<!-- `export FLAVOUR=cooperation` -->
|
||||
|
||||
- Run this command to initialise some default config (.env files which won't be checked into git):
|
||||
- Then run this command to initialise some default config (.env files which won't be checked into git):
|
||||
|
||||
`make pre-config`
|
||||
|
||||
|
|
|
|||
4
mix.lock
4
mix.lock
|
|
@ -6,7 +6,7 @@
|
|||
"absinthe_plug": {:hex, :absinthe_plug, "1.5.8", "38d230641ba9dca8f72f1fed2dfc8abd53b3907d1996363da32434ab6ee5d6ab", [:mix], [{:absinthe, "~> 1.5", [hex: :absinthe, repo: "hexpm", optional: false]}, {:plug, "~> 1.4", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm", "bbb04176647b735828861e7b2705465e53e2cf54ccf5a73ddd1ebd855f996e5a"},
|
||||
"activity_pub": {:git, "https://github.com/bonfire-networks/activity_pub", "ba358cfbd9f12121d4093b0f38695b9c0ad29fb2", [branch: "develop"]},
|
||||
"argon2_elixir": {:hex, :argon2_elixir, "2.4.1", "edb27bdd326bc738f3e4614eddc2f73507be6fedc9533c6bcc6f15bbac9c85cc", [:make, :mix], [{:comeonin, "~> 5.3", [hex: :comeonin, repo: "hexpm", optional: false]}, {:elixir_make, "~> 0.6", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm", "0e21f52a373739d00bdfd5fe6da2f04eea623cb4f66899f7526dd9db03903d9f"},
|
||||
"arrows": {:git, "https://github.com/bonfire-networks/arrows", "b49f7f4b2c175371196a35c70f384b92f8e34b7a", [branch: "main"]},
|
||||
"arrows": {:git, "https://github.com/bonfire-networks/arrows", "cc24f43d49ccea937e8819691e78c3439b08bc54", [branch: "main"]},
|
||||
"bamboo": {:hex, :bamboo, "2.2.0", "f10a406d2b7f5123eb1f02edfa043c259db04b47ab956041f279eaac776ef5ce", [:mix], [{:hackney, ">= 1.15.2", [hex: :hackney, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:mime, "~> 1.4", [hex: :mime, repo: "hexpm", optional: false]}, {:plug, "~> 1.0", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm", "8c3b14ba7d2f40cb4be04128ed1e2aff06d91d9413d38bafb4afccffa3ade4fc"},
|
||||
"bamboo_smtp": {:hex, :bamboo_smtp, "4.1.0", "ba547be4146ae592f63af05c6c7b7b5195b2b6ca57eeea9d80070b38eacd528b", [:mix], [{:bamboo, "~> 2.2.0", [hex: :bamboo, repo: "hexpm", optional: false]}, {:gen_smtp, "~> 1.1.1", [hex: :gen_smtp, repo: "hexpm", optional: false]}], "hexpm", "cb1a2856ab0507d10df609428314aa5e18231e8b1801a5bc6e42f319eeb50ad9"},
|
||||
"bonfire_api_graphql": {:git, "https://github.com/bonfire-networks/bonfire_api_graphql", "28637e66be443fed7fff5b640ae20ed5afb09f48", [branch: "main"]},
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
"bonfire_tag": {:git, "https://github.com/bonfire-networks/bonfire_tag", "9fffd27b85b4c98198ebb01ab4410a131619ea94", [branch: "main"]},
|
||||
"bonfire_ui_coordination": {:git, "https://github.com/bonfire-networks/bonfire_ui_coordination", "5f88cd620272ea80db3eb4147c923ac028098514", [branch: "main"]},
|
||||
"bonfire_ui_kanban": {:git, "https://github.com/bonfire-networks/bonfire_ui_kanban", "4beb7a1267a39bcdb7a4592bbd52246074db5b29", [branch: "main"]},
|
||||
"bonfire_ui_social": {:git, "https://github.com/bonfire-networks/bonfire_ui_social", "c4692df8a37214375c5c5785cdf1201f0a6aa78e", [branch: "main"]},
|
||||
"bonfire_ui_social": {:git, "https://github.com/bonfire-networks/bonfire_ui_social", "a116d22e76f6935d5f91fe813cb2b9c63b939cf9", [branch: "main"]},
|
||||
"bonfire_ui_valueflows": {:git, "https://github.com/bonfire-networks/bonfire_ui_valueflows", "753cc9c673d346a5a81498a4325c0ae75ebecde5", [branch: "main"]},
|
||||
"bonfire_valueflows": {:git, "https://github.com/bonfire-networks/bonfire_valueflows", "250577d7889ab4916a5397db4183ca5682d6ff4a", [branch: "main"]},
|
||||
"bonfire_valueflows_observe": {:git, "https://github.com/bonfire-networks/bonfire_valueflows_observe", "37a8aec7d655d76363bbb752e64c1aa8ea2c0761", []},
|
||||
|
|
|
|||
Loading…
Reference in a new issue