-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): Global explanation based on the docs
- Loading branch information
1 parent
4ba1e87
commit e9c94a1
Showing
3 changed files
with
28 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,31 @@ | ||
# AREA | ||
# Area | ||
|
||
## Team | ||
Area is an automation platform, available as a web app and a mobile app, that allows you to | ||
combine Actions and REactions [from a large range of integrations]((https://rezarahemtola.notion.site/Area-Integrations-f382af642ddb49d4b5a52e3fc307bfd9)) to fit your needs. | ||
|
||
### Frontend | ||
You can learn more about the project [in our documentation](https://docs.area.rezar.fr) π | ||
|
||
| [<img src="https://github.com/Tomi-Tom.png?size=85" width=85><br><sub>Tom BARITEAU--PETER</sub>](https://github.com/Tomi-Tom) | [<img src="https://github.com/axel-denis.png?size=85" width=85><br><sub>Axel DENIS</sub>](https://github.com/axel-denis) | ||
|:---:| :---: | | ||
## Getting started π | ||
|
||
### Backend | ||
To start using our amazing platform, go to [`https://area.rezar.fr`](https://area.rezar.fr) and setup your account to start creating workflows! | ||
|
||
| [<img src="https://github.com/Croos3r.png?size=85" width=85><br><sub>Dorian MOY</sub>](https://github.com/Croos3r) | [<img src="https://github.com/EdenComp.png?size=85" width=85><br><sub>Florian LAUCH</sub>](https://github.com/EdenComp) | ||
|:---:| :---: | | ||
If you want a more detailed guide of the different options to use Area (including self-hosted π»), [check this page](https://docs.area.rezar.fr/#/general/getting-started). | ||
|
||
### Full-stack & Project manager | ||
| [<img src="https://github.com/RezaRahemtola.png?size=85" width=85><br><sub>Reza Rahemtola</sub>](https://github.com/RezaRahemtola) | ||
| :---: | | ||
## How it works π€ | ||
|
||
If you're here for the technical details, we got you covered too! | ||
You can dive into the architecture documentation explaining how we are using [microservices](https://docs.area.rezar.fr/#/architecture/workers) | ||
and a [supervisor](https://docs.area.rezar.fr/#/architecture/supervisor) to create Docker containers on-demand. | ||
|
||
> π‘ Some pretty standard parts may not be covered, but don't hesitate to reach out by creating an issue on [our repository](https://github.com/RezaRahemtola/Area), we'll be happy to help you! | ||
## Contribute π€ | ||
|
||
If you want to go a step forward and participate in the development of features to enhance Area, we'd be glad to onboard you π₯ | ||
|
||
Reach out to [`[email protected]`](mailto:[email protected]) and we'll get back to you in a few business days! | ||
|
||
## Team β€οΈ | ||
|
||
| [<img src="https://github.com/Croos3r.png?size=85" width=85><br><sub>Dorian MOY</sub>](https://github.com/Croos3r)<br><sub>Backend</sub> | [<img src="https://github.com/EdenComp.png?size=85" width=85><br><sub>Florian LAUCH</sub>](https://github.com/EdenComp)<br><sub>Microservices</sub> | [<img src="https://github.com/Tomi-Tom.png?size=85" width=85><br><sub>Tom BARITEAU-PETER</sub>](https://github.com/Tomi-Tom)<br><sub>Mobile</sub> | [<img src="https://github.com/axel-denis.png?size=85" width=85><br><sub>Axel DENIS</sub>](https://github.com/axel-denis)<br><sub>Mobile</sub> | [<img src="https://github.com/RezaRahemtola.png?size=85" width=85><br><sub>Reza RAHEMTOLA</sub>](https://github.com/RezaRahemtola)<br><sub>Web & DevOps</sub> | ||
|:---:| :---: | :---: | :---: | :---: | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,7 +12,7 @@ You can learn more about the project [here](general/project) π | |
|
||
## Getting started π | ||
|
||
To start using our amazing platform, go to [`https://area.rezar.fr`](https://area.rezar.fr) and create your account to start creating workflows!\ | ||
To start using our amazing platform, go to [`https://area.rezar.fr`](https://area.rezar.fr) and setup your account to start creating workflows! | ||
|
||
If you want a more detailed guide of the different options to use Area (including self-hosted π»), [check this page](general/getting-started). | ||
|
||
|
@@ -26,7 +26,7 @@ and a [supervisor](architecture/supervisor) to create Docker containers on-deman | |
## Contribute π€ | ||
|
||
If you want to go a step forward and participate in the development of features to enhance Area, we'd be glad to onboard you π₯\ | ||
If you want to go a step forward and participate in the development of features to enhance Area, we'd be glad to onboard you π₯ | ||
|
||
Reach out to [`[email protected]`](mailto:[email protected]) and we'll get back to you in a few business days! | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters