Skip to content

Commit

Permalink
docs(README): Global explanation based on the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RezaRahemtola committed Nov 5, 2023
1 parent 4ba1e87 commit e9c94a1
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 14 deletions.
36 changes: 25 additions & 11 deletions README.md
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>
|:---:| :---: | :---: | :---: | :---: |
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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!

Expand Down
2 changes: 1 addition & 1 deletion frontend/web/app/(landing)/team/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const members = [
},
{
name: "Florian Lauch",
title: "Lead Workers",
title: "Lead Microservices",
image: "https://github.com/EdenComp.png",
github: "https://github.com/EdenComp",
linkedin: "https://www.linkedin.com/in/florianlauch/",
Expand Down

0 comments on commit e9c94a1

Please sign in to comment.