Move docs to mkdocs and improve them
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
This commit is contained in:
Thomas Citharel
@@ -1,47 +0,0 @@
|
||||
# Code of Conduct
|
||||
|
||||
This section explains Framasoft's commitment towards contributors to the [Mobilizon Project](https://joinmobilizon.org), as well as expectations that community members should have of one another. It is based on the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct) v1.4.
|
||||
|
||||
## Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers - including Framasoft - pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
We also follow the [Post-Meritocracy Manifesto](https://postmeritocracy.org).
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behaviour that contributes to creating a positive environment include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behaviour by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others’ private information, such as a physical or electronic address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
The Project maintainers are responsible for clarifying the standards of acceptable behaviour and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behaviour.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviours that they deem inappropriate, threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
|
||||
Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
|
||||
Representation of a project may be further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting the project team at tcit plus mobilizon at framasoft dot org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
|
||||
|
||||
---
|
||||
@@ -1,270 +0,0 @@
|
||||
# Contributing to Mobilizon
|
||||
|
||||
---
|
||||
|
||||
## How we collaborate
|
||||
|
||||
First off, thank you for considering contributing to Mobilizon!
|
||||
|
||||
Our aim for this project is to make you feel welcome as a contributor.
|
||||
We hugely value the comments and contributions of community members in the various
|
||||
publicly-accessible areas in use, which currently are:
|
||||
|
||||
* Home: [Home](https://joinmobilizon.org)
|
||||
* Wiki: [Project Wiki](https://framagit.org/framasoft/mobilizon/wikis) (GitLab)
|
||||
* Code: [Framagit](https://framagit.org/framasoft/mobilizon) (GitLab)
|
||||
* Issue tracking: [Framagit](https://framagit.org/framasoft/mobilizon) (GitLab)
|
||||
* Discussion: [Mobilizon forum](https://framacolibri.org/c/mobilizon) (Discourse)
|
||||
* Chat: [#Mobilizon:matrix.org](https://matrix.org/#/room/#Mobilizon:matrix.org) (Matrix) or `#mobilizon` on Freenode (IRC)
|
||||
|
||||
### How to communicate with others ?
|
||||
|
||||
As you may know, English is not the only language in the community and communicating in various languages can be quite tricky. Some might not understand what you're saying, while others have a hard time writing in a language that is not their primary language.
|
||||
|
||||
If you haven't noticed yet, French is the de-facto language for communication in various channels. This is because a huge part of our community speaks French, as Framasoft is a French organization.
|
||||
|
||||
We don't want to impose French as the only language in the project, though, because we would lose a ton of potential users and contributors that can help us make Mobilizon better.
|
||||
|
||||
You can write what you would like to tell us in the language you're most comfortable with and then use automagic translation to translate your message in English. It's far from perfect, but if we can understand the main idea you wanted to expose, it's sufficient.
|
||||
|
||||
Of course, you can and should express yourself directly in English if you're confident doing so!
|
||||
|
||||
### Other useful information
|
||||
|
||||
* It's early days for Mobilizon, so we're focused on laying down the foundations for the project. This means that you won't find much usable code yet.
|
||||
* We're working as openly and transparently as possible with this project. As a contributor or member of the Mobilizon community, almost everything you come across will link to some other things that you should have access to. If you don't have access, and you think you should, just ask!
|
||||
|
||||
### Contributopia
|
||||
|
||||
This project is part of [Framasoft](https://framasoft.org)'s [Contributopia Campaign](https://contributopia.org), creating and offering tools designed with a different set of values.
|
||||
|
||||
|
||||
|
||||
### We practice [Ethical Design](https://2017.ind.ie/ethical-design/)
|
||||
|
||||
We endeavour to build technology that respects human rights, human effort, and human experience, and hope you will join in this effort.
|
||||
|
||||
[](https://2017.ind.ie/ethical-design/)
|
||||
|
||||
---
|
||||
|
||||
## [Code Of Conduct](code_of_conduct.html)
|
||||
|
||||
We require all participants to read and accept our [Code of Conduct](code_of_conduct.html).
|
||||
|
||||
---
|
||||
|
||||
## How Can I Contribute
|
||||
|
||||
### Submitting Feature Requests, Enhancement Suggestions or Bug Reports
|
||||
|
||||
This section guides you through submitting a ✨ feature request, 💄 enhancement suggestions, and 🐛 bug reports for Mobilizon - anything from errors and crashes, to minor improvements, to completely new features.
|
||||
|
||||
When you post an issue, please include as many details as possible. **Fill in the issue template** (available below) to help us resolve issues faster.
|
||||
|
||||
### Before making a submission
|
||||
|
||||
Please go through the checklist below before posting any ✨ 💄 🐛
|
||||
|
||||
* **Check if you're using the latest version** of Mobilizon and all its relevant components and if you can get the desired behaviour by changing some config settings.
|
||||
* **Perform a cursory search** in the issue tracker to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
|
||||
* Never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to tcit plus mobilizon at framasoft dot org.
|
||||
|
||||
> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
|
||||
|
||||
### Suggesting Features & Enhancements
|
||||
|
||||
If you find yourself wishing for a feature that doesn't exist in Mobilizon, you are probably not alone. There are probably others out there with similar needs.
|
||||
|
||||
Open an issue providing the following information:
|
||||
|
||||
* **Use a clear and descriptive title** for the issue to identify the suggestion.
|
||||
* **Provide a description of the suggested enhancement** in as many details as possible, including the steps that you imagine you (as a user) would take if the feature you're requesting existed.
|
||||
* **Describe the current behaviour** and **explain which behaviour you would like to see instead** and why.
|
||||
* **Include screenshots and animated GIFs** which help demonstrate the steps or point out the parts of Mobilizon which your suggestion is related to. You can use a tool called [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [Silentcast](https://github.com/colinkeenan/silentcast) or [Byzanz](https://github.com/GNOME/byzanz) on Linux.
|
||||
* **Provide specific examples to demonstrate the enhancements**. If possible, include drawings, screenshots, or GIFs of similar features in another app.
|
||||
* **Explain why this enhancement would be useful** to most participants of Mobilizon and isn't something that can or should be implemented as a community extension.
|
||||
* **List some other communities, platforms or apps where this enhancement exists.**
|
||||
|
||||
### Reporting Bugs 🐛
|
||||
|
||||
Open an issue providing the following information by filling in the issue template below, explaining the problem and including additional details to help maintainers reproduce the problem:
|
||||
|
||||
* **Use a clear and descriptive title** for the issue to identify the problem.
|
||||
* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining where you started in Mobilizon, and then which actions you took. When listing steps, **don't just say what you did, but explain how you did it**. For example, if you moved the cursor to the end of a line, explain if you used the mouse or a keyboard shortcut, and if so which one?
|
||||
* **Provide specific examples to demonstrate the steps**. Include links to pages, screenshots, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
|
||||
* **Describe the behaviour you observed after following the steps** and point out what exactly is the problem with that behaviour.
|
||||
* **Explain which behaviour you expected to see instead and why.**
|
||||
* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [Silentcast](https://github.com/colinkeenan/silentcast) or [Byzanz](https://github.com/GNOME/byzanz) on Linux.
|
||||
* **If you're reporting a crash**, include a crash report with error logs.
|
||||
* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
|
||||
|
||||
Provide more context by answering these questions:
|
||||
|
||||
* **Did the problem start happening recently** (e.g. after updating to a new version) or was this always a problem?
|
||||
* If the problem started happening recently, **can you reproduce the problem in an older version?** What's the most recent version in which the problem doesn't happen?
|
||||
* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
|
||||
* If the problem is related to an event, comment or actor (eg. user or group), **does the problem happen for all of them or only some?** Does the problem happen only when working with local (originating from your Mobilizon instance) or remote ones, with anything specific about the object? Is there anything else special about the actors or events in question?
|
||||
|
||||
Include details about your configuration and environment:
|
||||
|
||||
* **Which version of each component are you using?**
|
||||
* **What's the name and version of the OS you're using**?
|
||||
* **Are you running in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
|
||||
|
||||
---
|
||||
|
||||
### Contributing
|
||||
|
||||
A common misconception about contributing to free and open source projects is that you need to contribute code. In fact, it’s often the other parts of a project that are most overlooked. You’ll do the project a huge favour by offering to pitch in with these types of contributions!
|
||||
|
||||
Even if you like to write code, other types of contributions are a great way to get involved with a project and meet other community members. Building those relationships may open up unexpected opportunities.
|
||||
|
||||
#### Do you like to design? 🎨
|
||||
|
||||
* Restructure layouts to improve the project's usability.
|
||||
* Conduct user research to reorganise and refine the project's navigation or menus.
|
||||
* Create art for icons and app screens.
|
||||
|
||||
#### Do you like to write? ✏
|
||||
|
||||
* Write and improve the project's documentation.
|
||||
* Write tutorials for the project.
|
||||
* Curate a wiki page of examples showing how the project can be used.
|
||||
|
||||
#### Do you like organising? 📥
|
||||
|
||||
* Link to duplicate issues, and suggest new issue labels, to keep things organised.
|
||||
* Go through open issues and suggest revisiting or closing old ones.
|
||||
* Ask clarifying questions on recently opened issues to move the discussion forward.
|
||||
|
||||
#### Do you like helping people? 🙋
|
||||
|
||||
* Answer questions about the project on forums and other sites.
|
||||
* Answer questions for people on open issues.
|
||||
|
||||
#### Do you like helping others code? 👐
|
||||
|
||||
* Review code on other people's submissions.
|
||||
* Write tutorials for how a project can be used.
|
||||
* Offer to mentor another contributor.
|
||||
|
||||
#### Do you like to code? 🔩
|
||||
|
||||
* Find an open issue to tackle.
|
||||
* Offer to help write a new feature.
|
||||
* Improve tooling, testing & deployment options.
|
||||
* Read the **next section for guidelines**.
|
||||
|
||||
---
|
||||
|
||||
### Contributing Code
|
||||
|
||||
Unsure where to begin contributing? You can start by looking through issues tagged with:
|
||||
|
||||
* [`first-timers-only`](https://framagit.org/framasoft/mobilizon/issues?scope=all&utf8=✓&state=opened&label_name[]=🌱 first-timers-only) [https://www.firsttimersonly.com](https://www.firsttimersonly.com)- issues which should only require a few lines of code, and a test or two.
|
||||
* [`help-wanted`](https://framagit.org/framasoft/mobilizon/issues?label_name[]=🙏 help-wanted) - issues which should be a bit more involved than `first-timers-only` issues.
|
||||
|
||||
#### Local development
|
||||
|
||||
Mobilizon can be developed locally. For instructions on how to do this, please see [the documentation](development.html).
|
||||
|
||||
#### Coding & git practices
|
||||
|
||||
* We use GitLab's merge requests as our code review tool.
|
||||
* We encourage any dev to comment on merge requests and we think of the merge request not as a "please approve my code" but as a space for co-developing.
|
||||
* We develop features on separate branches identified by issue numbers.
|
||||
* We don't currently use release branches or tags because we don't have release management at this phase of development.
|
||||
|
||||
#### How to make changes
|
||||
|
||||
* Make your changes on a separate branch which includes an issue number e.g. `1234-some-new-feature` where 1234 is the issue number where the feature is documented. Make sure the branch is based on `master`.
|
||||
* Do not commit changes to files that are irrelevant to your feature or bugfix.
|
||||
* Use commit messages descriptive of your changes.
|
||||
* Push to your own repository fork.
|
||||
* Create a merge request at GitLab.
|
||||
|
||||
#### Git commit messages
|
||||
|
||||
* Limit the first line to 72 characters or less, referencing relevant issue numbers.
|
||||
* Be as descriptive as you want after the first line.
|
||||
* Consider starting the commit message with an applicable emoji (see Issue & Commit Categories below).
|
||||
|
||||
#### Merge requests
|
||||
|
||||
* Follow [the code styleguides](styleguide.html).
|
||||
* Document new code based on [the documentation styleguide](https://hexdocs.pm/elixir/writing-documentation.html).
|
||||
* Each merge request should implement ONE feature or bugfix. If you want to add or fix more than one thing, submit more than one merge request.
|
||||
* Fill in the merge request template below.
|
||||
* Include relevant issue number(s) in the merge request title.
|
||||
* Include screenshots or animated GIFs in your merge request whenever possible.
|
||||
* End all files with a newline.
|
||||
|
||||
#### Template for merge requests
|
||||
|
||||
* Description of the change
|
||||
* Applicable issue numbers
|
||||
* Alternate designs/implementations
|
||||
* Benefits of this implementation
|
||||
* Possible drawbacks
|
||||
* Why should this be part of a core component?
|
||||
* Testing process
|
||||
|
||||
---
|
||||
|
||||
#### Issue & Commit Categories
|
||||
|
||||
* 🚑 `critical` : Critical hotfix!
|
||||
* 💄 `enhancement` : General improvements.
|
||||
* ✨ `feature` : New features.
|
||||
* 🐛 `bug` : Confirmed bugs, or reports that are likely to be bugs.
|
||||
* 🙋 `question` : Questions (e.g. how can I do X?).
|
||||
* 📮 `feedback` : General feedback.
|
||||
* 🎨 `ui` : Visual design.
|
||||
* 📜 `copy` : Text in the apps, or translations.
|
||||
* ℹ `documentation` : Documentation.
|
||||
* 🐎 `performance` : Performance.
|
||||
* 🔒 `security` : Security.
|
||||
* 🔌 `api` : Mobilizon's APIs.
|
||||
* 👽 `external` : External libraries or API integrations.
|
||||
* ⚠ `exception` : Uncaught exceptions.
|
||||
* 🔥 `crash` : Crash.
|
||||
* 🔣 `encoding` : Character encoding or data serialization issue.
|
||||
* 🚚 `cleanup` : Removing, moving or refactoring code or files.
|
||||
* ✅ `tests` : Testing.
|
||||
|
||||
#### Issue Status
|
||||
|
||||
* 💬 `discussion` : Discussion to clarify this issue is ongoing.
|
||||
* 🔜 `todo` : This has been discussed and now needs work.
|
||||
* 🔁 `needs-more-info` : More information needs to be collected about these problems or feature requests (e.g. steps to reproduce).
|
||||
* 💡 `idea` : Needs to be discussed further. Could be a feature request which might be good to first implement as a community extension.
|
||||
* 🚧 `in-progress` : Someone is working on this...
|
||||
* 🙏 `help-wanted` : The Mobilizon core team would appreciate help from the community in resolving these issues.
|
||||
* 🌱 `first-timers-only` : Less complex issues which would be good first issues to work on for users who want to contribute.
|
||||
* 🔢 `needs-reproduction` : Likely bugs, but haven't been reliably reproduced.
|
||||
* 🔴 `blocked` : Blocked on other issues.
|
||||
* 2️⃣ `duplicate` : Duplicate of another issue, i.e. has been reported before.
|
||||
* 🙅 `wontfix` : The Mobilizon core team has decided not to fix these issues (or add these features) for now, because they're working as intended, or some other reason.
|
||||
* 🚮 `invalid` : Issues which are not valid (e.g. spam or submitted by error).
|
||||
|
||||
|
||||
#### Merge Request Status
|
||||
|
||||
* 🚧 `in-progress` : Still being worked on, more changes will follow.
|
||||
* 🚏 `needs-review` : Needs code review and approval from maintainers.
|
||||
* 🔍 `under-review` : Being reviewed by maintainers.
|
||||
* 🔧 `changes-required` : Needs to be updated based on review comments and then reviewed again.
|
||||
* 👀 `needs-testing` : Needs manual testing.
|
||||
|
||||
---
|
||||
|
||||
## Credits
|
||||
The following documents have greatly helped us put this together. A big thank you to their authors and contributors!
|
||||
|
||||
* [MoodleNet's own Contributing document](https://gitlab.com/moodlenet/project/meta/issues/16)
|
||||
* [Contributor Covenant](https://www.contributor-covenant.org/version/1/4/code-of-conduct)
|
||||
* [Open Source Guides](https://opensource.guide)
|
||||
* [Holochain's Development Protocols](https://github.com/holochain/holochain-proto/wiki/Development-Protocols)
|
||||
* [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md)
|
||||
* [Funkwhale's pad on how to Communicate with others](https://hackmd.io/qESHvdHZSWuhLNjeanaVQw?both)
|
||||
@@ -1,49 +0,0 @@
|
||||
# Development
|
||||
|
||||
Clone the repository:
|
||||
```bash
|
||||
# With HTTPS
|
||||
git clone https://framagit.org/framasoft/mobilizon && cd mobilizon
|
||||
|
||||
# With SSH
|
||||
git clone git@framagit.org:framasoft/mobilizon.git && cd mobilizon
|
||||
```
|
||||
|
||||
Run Mobilizon:
|
||||
* with Docker and Docker-Compose (**Recommended**)
|
||||
* without Docker and Docker-Compose (This involves more work on your part, use Docker and Docker-Compose if you can)
|
||||
|
||||
## With Docker and Docker-Compose
|
||||
|
||||
* Install [Docker](https://docs.docker.com/install/#supported-platforms) and [Docker-Compose](https://docs.docker.com/compose/install/) for your system.
|
||||
* Run `make start` to build, then launch a database container and an API container.
|
||||
* Follow the progress of the build with `docker-compose logs -f`.
|
||||
* Access `localhost:4000` in your browser once the containers are fully built and launched.
|
||||
|
||||
## Without Docker and Docker-Compose
|
||||
|
||||
* Install dependencies:
|
||||
* Elixir (and Erlang) by following the instructions at [https://elixir-lang.github.io/install.html](https://elixir-lang.github.io/install.html)
|
||||
* [PostgreSQL]() with PostGIS
|
||||
* Install NodeJS (we guarantee support for the latest LTS and later) 
|
||||
* Start services:
|
||||
* Start postgres
|
||||
* Setup services:
|
||||
* Make sure the postgis extension is installed on your system.
|
||||
* Create a postgres user with database creation capabilities, using the
|
||||
following: `createuser -d -P mobilizon` and set `mobilizon` as the password.
|
||||
* Install packages
|
||||
* Fetch backend Elixir dependencies with `mix deps.get`.
|
||||
* Go into the `cd js` directory, `yarn install` and then back `cd ../`
|
||||
* Setup
|
||||
* Create your database with `mix ecto.create`.
|
||||
* Create the postgis extension on the database with a postgres user that has
|
||||
superuser capabilities: `psql mobilizon_dev`
|
||||
|
||||
``` create extension if not exists postgis; ```
|
||||
|
||||
* Run migrations: `mix ecto.migrate`.
|
||||
* Start Phoenix endpoint with `mix phx.server`. The client development server will also automatically be launched and will reload on file change.
|
||||
|
||||
Now you can visit [`localhost:4000`](http://localhost:4000) in your browser
|
||||
and see the website (server *and* client) in action.
|
||||
@@ -1,28 +0,0 @@
|
||||
# Styleguide
|
||||
|
||||
## Elixir
|
||||
|
||||
We format our code with the Elixir Formatter and check for issues with [Credo](https://github.com/rrrene/credo) (a few rules are not blocking).
|
||||
|
||||
Please run these two commands before pushing code:
|
||||
* `mix format`
|
||||
* `mix credo`
|
||||
|
||||
These two commands must not return an error code, since they are required to pass inside CI.
|
||||
|
||||
## Front-end
|
||||
|
||||
### Linting
|
||||
|
||||
We use `tslint` and `eslint` with the `airbnb` preset.
|
||||
Errors should be reported when the development server is running or when building a production bundle `yarn run build`.
|
||||
|
||||
Please run the following command before pushing code `yarn run lint`.
|
||||
|
||||
This command must not return an error code, since it's required to pass inside CI.
|
||||
|
||||
We also try to follow the [official Vue.js style guide](https://vuejs.org/v2/style-guide/).
|
||||
|
||||
### Styleguide
|
||||
|
||||
We present the components used on Mobilizon's front-end here: https://framasoft.frama.io/mobilizon/frontend/. The documentation is builded through [Vue Styleguidist](https://vue-styleguidist.github.io/)
|
||||
@@ -1,61 +0,0 @@
|
||||
# Tests
|
||||
|
||||
## Backend
|
||||
|
||||
The backend uses `ExUnit`.
|
||||
|
||||
To launch all the tests:
|
||||
```bash
|
||||
mix test
|
||||
```
|
||||
|
||||
> If you're using Docker, you can use `make test`
|
||||
|
||||
If you want test coverage:
|
||||
|
||||
```bash
|
||||
mix coveralls.html
|
||||
```
|
||||
|
||||
It will show the coverage and will output a `cover/excoveralls.html` file.
|
||||
|
||||
If you want to test a single file:
|
||||
|
||||
```bash
|
||||
mix test test/mobilizon/actors/actors_test.exs
|
||||
```
|
||||
|
||||
If you want to test a specific test, block or line:
|
||||
|
||||
```bash
|
||||
mix test test/mobilizon/actors/actors_test.exs:85
|
||||
```
|
||||
|
||||
> Note: The coveralls.html also works the same
|
||||
|
||||
## Front-end
|
||||
|
||||
### Unit tests
|
||||
|
||||
Not done yet.
|
||||
|
||||
### End-to-end tests
|
||||
|
||||
We use [Cypress](https://cypress.io) for End-to-end testing.
|
||||
|
||||
You first need to run the webserver with the `e2e` environment: `MIX_ENV=e2e mix phx.server`. The same environment parameters as the `dev` environment must be provided.
|
||||
This allows to run database operations in the sandbox and not pollute your database.
|
||||
|
||||
Then, run `MIX_ENV=e2e mix run priv/repo/e2e.seed.exs` to have some initial data inside your instance for the tests.
|
||||
|
||||
When inside the `js` directory, you can do either
|
||||
```bash
|
||||
npx cypress run
|
||||
```
|
||||
to run the tests, or
|
||||
```bash
|
||||
npx cypress open
|
||||
```
|
||||
to open the interactive GUI.
|
||||
|
||||
Cypress provided [a subscription](https://www.cypress.io/oss-plan) to their recording dashboard since Mobilizon is an Open-Source project. Thanks!
|
||||
@@ -1,53 +0,0 @@
|
||||
# Dependencies
|
||||
|
||||
|
||||
- [Debian / Ubuntu and derivatives](#debian--ubuntu-and-derivatives)
|
||||
- [Arch Linux](#arch-linux)
|
||||
- [Other distributions](#other-distributions)
|
||||
|
||||
## Debian / Ubuntu and derivatives
|
||||
1. On a fresh Debian/Ubuntu, as root user, install basic utility programs needed for the installation
|
||||
|
||||
```
|
||||
sudo apt install curl unzip vim
|
||||
```
|
||||
|
||||
2. It would be wise to disable root access and to continue this tutorial with a user with sudoers group access
|
||||
3. Install certbot (choose instructions for nginx and your distribution):
|
||||
[https://certbot.eff.org/all-instructions](https://certbot.eff.org/all-instructions)
|
||||
4. Install NodeJS 10.x (current LTS):
|
||||
[https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
|
||||
5. Install yarn, and be sure to have [a recent version](https://github.com/yarnpkg/yarn/releases/latest):
|
||||
[https://yarnpkg.com/en/docs/install#linux-tab](https://yarnpkg.com/en/docs/install#linux-tab)
|
||||
6. Install Erlang and Elixir:
|
||||
[https://elixir-lang.org/install.html#unix-and-unix-like](https://elixir-lang.org/install.html#unix-and-unix-like)
|
||||
7. Install PostGIS:
|
||||
[https://postgis.net/install/](https://postgis.net/install/)
|
||||
8. Run:
|
||||
|
||||
```
|
||||
sudo apt update
|
||||
sudo apt install nginx postgresql postgresql-contrib openssl make git esl-erlang elixir postgis imagemagick
|
||||
```
|
||||
|
||||
Now that dependencies are installed, before running Mobilizon you should start PostgreSQL:
|
||||
```
|
||||
sudo systemctl start postgresql
|
||||
```
|
||||
|
||||
## Arch Linux
|
||||
|
||||
1. Run:
|
||||
|
||||
```
|
||||
sudo pacman -S nodejs postgresql openssl git wget unzip base-devel yarn nginx elixir postgis imagemagick
|
||||
```
|
||||
|
||||
Now that dependencies are installed, before running Mobilizon you should start PostgreSQL and Redis:
|
||||
```
|
||||
sudo systemctl start postgresql
|
||||
```
|
||||
|
||||
## Other distributions
|
||||
|
||||
Feel free to update this file in a pull request!
|
||||
@@ -1,15 +0,0 @@
|
||||
# Docker
|
||||
|
||||
You can quickly get a server running using Docker. You'll need both [Docker](https://www.docker.com/community-edition) and [Docker-Compose](https://docs.docker.com/compose/install/).
|
||||
|
||||
Start by cloning the repo
|
||||
```bash
|
||||
git clone https://framagit.org/framasoft/mobilizon && cd mobilizon
|
||||
```
|
||||
|
||||
Then, just run `make` to build containers.
|
||||
```bash
|
||||
make
|
||||
```
|
||||
|
||||
This will start a database container, an API container and the front-end container running on localhost.
|
||||
@@ -1,137 +0,0 @@
|
||||
# Install
|
||||
|
||||
## Dependencies
|
||||
|
||||
Follow the steps of the [dependencies guide](dependencies.html)
|
||||
|
||||
## Database
|
||||
|
||||
Create the production database and a mobilizon user inside PostgreSQL:
|
||||
|
||||
```bash
|
||||
sudo -u postgres createuser -P mobilizon
|
||||
sudo -u postgres createdb -O mobilizon mobilizon_prod
|
||||
```
|
||||
|
||||
Then enable extensions Mobilizon needs:
|
||||
|
||||
```bash
|
||||
sudo -u postgres psql -c "CREATE EXTENSION postgis;" mobilizon_prod
|
||||
sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" mobilizon_prod
|
||||
sudo -u postgres psql -c "CREATE EXTENSION unaccent;" mobilizon_prod
|
||||
```
|
||||
|
||||
|
||||
## Mobilizon user
|
||||
|
||||
Create a `mobilizon` user with `/home/mobilizon` home:
|
||||
```bash
|
||||
sudo adduser --disabled-login mobilizon
|
||||
sudo -i -u mobilizon
|
||||
```
|
||||
|
||||
**On FreeBSD**
|
||||
|
||||
```bash
|
||||
sudo pw useradd -n mobilizon -d /home/mobilizon -s /usr/local/bin/bash -m
|
||||
sudo passwd mobilizon
|
||||
```
|
||||
|
||||
You can now fetch the code with git:
|
||||
```bash
|
||||
git clone https://framagit.org/framasoft/mobilizon live && cd live
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
### Backend
|
||||
|
||||
Install Elixir dependencies
|
||||
|
||||
```bash
|
||||
mix deps.get
|
||||
```
|
||||
|
||||
Configure your instance with
|
||||
|
||||
```bash
|
||||
mix mobilizon.instance gen
|
||||
```
|
||||
|
||||
This will ask you questions about your instance and generate a `.env.prod` file.
|
||||
|
||||
### Migration
|
||||
|
||||
Run database migrations: `mix ecto.migrate`. You will have to do this again after most updates.
|
||||
|
||||
> If some migrations fail, it probably means you're not using a recent enough version of PostgreSQL,
|
||||
or that you haven't installed [the required extensions](#database).
|
||||
|
||||
### Front-end
|
||||
|
||||
Go into the `js/` directory
|
||||
|
||||
```bash
|
||||
cd js
|
||||
```
|
||||
|
||||
and install the Javascript dependencies
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
Finally, build the front-end with
|
||||
```bash
|
||||
yarn run build
|
||||
```
|
||||
|
||||
## Services
|
||||
|
||||
### Systemd
|
||||
|
||||
Copy the `support/systemd/mobilizon.service` to `/etc/systemd/system`.
|
||||
|
||||
```bash
|
||||
sudo cp support/systemd/mobilizon.service /etc/systemd/system/
|
||||
```
|
||||
|
||||
Reload Systemd to detect your new file
|
||||
|
||||
```bash
|
||||
sudo systemctl daemon-reload
|
||||
```
|
||||
|
||||
And enable the service
|
||||
|
||||
```bash
|
||||
systemctl enable --now mobilizon.service
|
||||
```
|
||||
|
||||
It will run Mobilizon and enable startup on boot. You can follow the logs with
|
||||
|
||||
```bash
|
||||
sudo journalctl -fu mobilizon.service
|
||||
```
|
||||
|
||||
The Elixir server runs on port 4000 on the local interface only, so you need to add a reverse-proxy.
|
||||
|
||||
## Reverse proxy
|
||||
|
||||
### Nginx
|
||||
|
||||
Copy the file from `support/nginx/mobilizon.conf` to `/etc/nginx/sites-available`.
|
||||
|
||||
```bash
|
||||
sudo cp support/nginx/mobilizon.conf /etc/nginx/sites-available
|
||||
```
|
||||
|
||||
Then symlink the file into the `/etc/nginx/sites-enabled` directory.
|
||||
|
||||
```bash
|
||||
sudo ln -s /etc/nginx/sites-available/mobilizon.conf /etc/nginx/sites-enabled/
|
||||
```
|
||||
|
||||
Edit the file `/etc/nginx/sites-available` and adapt it to your own configuration.
|
||||
|
||||
Test the configuration with `sudo nginx -t` and reload nginx with `systemctl reload nginx`.
|
||||
@@ -1,64 +0,0 @@
|
||||
# Mobilizon
|
||||
|
||||
<p align="center">
|
||||
<a href="https://joinmobilizon.org">
|
||||
<img src="https://lutim.cpy.re/qVYC86G9.png" alt="Mobilizon">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
Mobilizon is your federated organization and mobilization platform. Gather people with a convivial, ethical, and emancipating tool.
|
||||
|
||||
<p align="center">
|
||||
<strong>Developed with ♥ by <a href="https://framasoft.org">Framasoft</a></strong>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://framasoft.org">
|
||||
<img width="150px" src="https://lutim.cpy.re/Prd3ci7G.png" alt="Framasoft logo"/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
## Introduction
|
||||
|
||||
Mobilizon is a tool designed to create platforms for managing communities and events. Its purpose is to help as many people as possible to free themselves from Facebook groups and events, from Meetup, etc.
|
||||
|
||||
The Mobilizon software is under a Free licence, so anyone can host a Mobilizon server, called an instance. These instances may federate with each other, so any person with an account on *ExampleMeet* will be able to register to an event created on *SpecimenEvent*.
|
||||
|
||||
## ✨ Features
|
||||
|
||||
### 👤 Identities
|
||||
|
||||
Do you want to separate your family gatherings from your associative activities or militant mobilizations?
|
||||
You will have the power to create multiple identities from the same account, like so many social masks.
|
||||
|
||||
---
|
||||
|
||||
### 📅 Events and groups
|
||||
|
||||
Create your events and make sure they will appeal to everybody.
|
||||
Privacy settings and participants roles are supported.
|
||||
There's no lock-in, you can interact with the event without registration.
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
We appreciate any contribution to Mobilizon. Check our [Contributing](contributing.html) page for more information.
|
||||
|
||||
## Links
|
||||
|
||||
### Learn more
|
||||
* 🌐 Official website: [https://joinmobilizon.org](https://joinmobilizon.org)
|
||||
* 💻 Source: [https://framagit.org/framasoft/mobilizon](https://framagit.org/framasoft/mobilizon)
|
||||
* 📝 Wiki: [https://framagit.org/framasoft/mobilizon/wikis/home](https://framagit.org/framasoft/mobilizon/wikis/home)
|
||||
|
||||
### Discuss
|
||||
* 💬 Matrix: `#Mobilizon:matrix.org` [Riot](https://riot.im/app/#/room/#Mobilizon:matrix.org)
|
||||
* #️⃣ IRC: `#mobilizon` on Freenode
|
||||
* 🗣️ Forum: [https://framacolibri.org/c/mobilizon](https://framacolibri.org/c/mobilizon)
|
||||
|
||||
### Follow
|
||||
* 🐘 Mastodon: [https://framapiaf.org/@mobilizon](https://framapiaf.org/@mobilizon)
|
||||
* 🐦 Twitter [https://twitter.com/@joinmobilizon](https://twitter.com/@joinmobilizon)
|
||||
|
||||
Note: Most federation code comes from [Pleroma](https://pleroma.social), which is `Copyright © 2017-2018 Pleroma Authors - AGPL-3.0`
|
||||
Reference in New Issue
Block a user