Skip to content

Commit 89870c1

Browse files
committed
readme
1 parent 6a5d233 commit 89870c1

File tree

3 files changed

+90
-74
lines changed

3 files changed

+90
-74
lines changed

README.md

Lines changed: 42 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -7,40 +7,43 @@ Get to know AIPlan, a professional project management platform that helps teams
77
The product provides convenient tools for planning, tracking, and completing tasks, as well as for teamwork within a team.
88
The system is designed for small, medium-sized teams and for large organizations that seek to optimize work processes, improve communication and increase productivity.
99

10+
You can easily transfer your work from Jira, as the **AIPlan** implements simple and convenient **project import from Jira**. The built-in **AIDoc** documentation management system offers **an analog of Confluence** with a convenient editor and the ability to collaborate on documents.
11+
1012
The AIPLAN is constantly being improved. Your suggestions and bug reports help us to become better. Create support requests. https://t.me/aiplan_faq .
1113

1214
## 🌟 Key features
1315
1. **Task Management**:
16+
- Transfer all your tasks from Jira in a few clicks.
1417
- Create tasks with deadlines, priorities, and responsible persons.
1518
- The ability to link tasks to each other for more detailed planning.
1619
- Assigning roles and access rights to project participants.
1720
- Real-time task completion status tracking.
18-
- Working with documents:
21+
2. **Working on documents**:
1922
- The ability to create and store documents directly in the system.
2023
- A convenient text editor for editing documents.
2124
- Organize documents into folders and projects for easy access.
22-
2. **Forms**:
25+
3. **Forms**:
2326
- Create forms to collect feedback or data.
2427
- Generation of unique links to forms that can be sent to users (both within the team and to external participants).
2528
- Automatic saving of the received data in the system.
26-
3. **Calendar**:
29+
4. **Calendar**:
2730
- An interactive calendar for viewing all tasks and activities by day, week or month.
2831
- The ability to filter tasks by responsible persons, projects or statuses.
29-
4. **Video Calls and Conferences**:
32+
5. **Video Calls and Conferences**:
3033
- Built-in video calling tool directly in the system.
3134
- The ability to organize meetings with team members without the need to use third-party applications.
3235
- Screen interaction support: screen demonstration during calls.
3336
- Record meetings for later viewing or analysis.
34-
5. **Integration**:
37+
6. **Integration**:
3538
- The ability to export data in formats .docx, .pdf.
3639
- The ability to import data from Jira.
37-
6. **Reports and analytics**:
40+
7. **Reports and analytics**:
3841
- Tracking user activity on projects.
39-
7. **Notifications and Reminders**:
42+
8. **Notifications and Reminders**:
4043
- Customizable notifications about new tasks and any changes to them.
4144
- Support for notifications via email, Telegram and within the system.
4245

43-
## Documentation
46+
## 📝 Documentation
4447
If you have any questions and for a detailed study of the product's capabilities, you can always refer to the User's Manual, which you will find inside the product.
4548

4649
## How to install
@@ -53,32 +56,34 @@ docker-compose up -d
5356

5457
## Application Parameters
5558

56-
| Parameter | Description | Type |
57-
| ----------------------- | -------------------------------------------------------------------------- | ------ |
58-
| `SECRET_KEY` | The key for generating JWT tokens. | string |
59-
| `AWS_REGION` | Minio region | string |
60-
| `AWS_ACCESS_KEY_ID` | minio login | string |
61-
| `AWS_SECRET_ACCESS_KEY` | minio password | string |
62-
| `AWS_S3_ENDPOINT_URL` | Path to minio | string |
63-
| `AWS_S3_BUCKET_NAME` | Name of the minio bucket | string |
64-
| `DATABASE_URL` | DSN of the database | string |
65-
| `DEFAULT_EMAIL` | Email of the standard user (password `password123` at creation) | string |
66-
| `EMAIL_ACTIVITY_DISABLED`| Disabling sending notifications to | bool |
67-
| `EMAIL_HOST` | Path to the mail server | string |
68-
| `EMAIL_HOST_USER` | Mail server login | string |
69-
| `EMAIL_HOST_PASSWORD` | Mail server password | string |
70-
| `EMAIL_PORT` | Mail server port | int |
71-
| `EMAIL_FROM` | Mailing list email | string |
72-
| `EMAIL_WORKERS` | Number of parallel mail notification handlers of the application | int |
73-
| `WEB_URL` | External address of the application | string |
74-
| `JITSI_URL` | Address of the jitsi conferences | string |
75-
| `FRONT_PATH` | The path to the compiled front (if specified, the back will return static) | string |
76-
| `NOTIFICATIONS_PERIOD` | Time period of a batch of email notifications | int |
77-
| `TELEGRAM_BOT_TOKEN` | Telegram bot token | string |
78-
| `TELEGRAM_COMMANDS_DISABLED` | Disabling telegram bot commands | bool |
79-
| `SESSIONS_DB_PATH` | Path to the session database file | string |
80-
| `SIGN_UP_ENABLE` | Enabling registration in the | bool |
81-
| `DEMO` | Demo mode | bool |
82-
| `SWAGGER_ENABLED` | Enabling the Swagger API documentation at /api/swagger | bool |
83-
| `NY_ENABLE` | Enabling the New Year theme | bool |
84-
| `CAPTCHA_DISABLED` | Disabling captcha | bool |
59+
| Parameter | Description | Type |
60+
| ---------------------------- | -------------------------------------------------------------------------- | ------ |
61+
| `SECRET_KEY` | The key for generating JWT tokens. | string |
62+
| `AWS_REGION` | Minio region | string |
63+
| `AWS_ACCESS_KEY_ID` | minio login | string |
64+
| `AWS_SECRET_ACCESS_KEY` | minio password | string |
65+
| `AWS_S3_ENDPOINT_URL` | Path to minio | string |
66+
| `AWS_S3_BUCKET_NAME` | Name of the minio bucket | string |
67+
| `DATABASE_URL` | DSN of the database | string |
68+
| `DEFAULT_EMAIL` | Email of the standard user (password `password123` at creation) | string |
69+
| `EMAIL_ACTIVITY_DISABLED` | Disabling sending notifications to | bool |
70+
| `EMAIL_HOST` | Path to the mail server | string |
71+
| `EMAIL_HOST_USER` | Mail server login | string |
72+
| `EMAIL_HOST_PASSWORD` | Mail server password | string |
73+
| `EMAIL_PORT` | Mail server port | int |
74+
| `EMAIL_FROM` | Mailing list email | string |
75+
| `EMAIL_WORKERS` | Number of parallel mail notification handlers of the application | int |
76+
| `WEB_URL` | External address of the application | string |
77+
| `JITSI_URL` | Address of the jitsi conferences | string |
78+
| `JITSI_JWT_SECRET` | Secret key for jitsi auth JWT token | string |
79+
| `JITSI_APP_ID` | Jitsi app ID for JWT iss field | string |
80+
| `FRONT_PATH` | The path to the compiled front (if specified, the back will return static) | string |
81+
| `NOTIFICATIONS_PERIOD` | Time period of a batch of email notifications | int |
82+
| `TELEGRAM_BOT_TOKEN` | Telegram bot token | string |
83+
| `TELEGRAM_COMMANDS_DISABLED` | Disabling telegram bot commands | bool |
84+
| `SESSIONS_DB_PATH` | Path to the session database file | string |
85+
| `SIGN_UP_ENABLE` | Enabling registration in the | bool |
86+
| `DEMO` | Demo mode | bool |
87+
| `SWAGGER_ENABLED` | Enabling the Swagger API documentation at /api/swagger | bool |
88+
| `NY_ENABLE` | Enabling the New Year theme | bool |
89+
| `CAPTCHA_DISABLED` | Disabling captcha | bool |

0 commit comments

Comments
 (0)