Skip to content

Commit 5d2124f

Browse files
paulocastellanopaulocastellano
committed
feat: add documentation for connecting social media platforms and getting started guides.
1 parent d5485a8 commit 5d2124f

14 files changed

Lines changed: 876 additions & 0 deletions

File tree

‎docs/README.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# TryPost Documentation
2+
3+
Welcome to the TryPost documentation. Here you'll find everything you need to install, configure, and use TryPost.
4+
5+
## Getting Started
6+
7+
- [Installation](getting-started/installation.md) - Install TryPost on your server
8+
- [Configuration](getting-started/configuration.md) - Configure environment variables
9+
- [First Steps](getting-started/first-steps.md) - Your first post with TryPost
10+
11+
## Platforms
12+
13+
Learn how to connect your social media accounts:
14+
15+
- [Overview](platforms/README.md) - Supported platforms and requirements
16+
- [LinkedIn](platforms/linkedin.md)
17+
- [X (Twitter)](platforms/x-twitter.md)
18+
- [Facebook](platforms/facebook.md)
19+
- [Instagram](platforms/instagram.md)
20+
- [TikTok](platforms/tiktok.md)
21+
- [YouTube](platforms/youtube.md)
22+
- [Threads](platforms/threads.md)
23+
- [Pinterest](platforms/pinterest.md)
24+
- [Bluesky](platforms/bluesky.md)
25+
- [Mastodon](platforms/mastodon.md)
26+
27+
## Features
28+
29+
- [Scheduling Posts](features/scheduling.md)
30+
- [Workspaces](features/workspaces.md)
31+
- [Team Management](features/team.md)
32+
33+
## Self-Hosting
34+
35+
- [Requirements](self-hosting/requirements.md)
36+
- [Production Setup](self-hosting/production.md)
37+
- [Docker](self-hosting/docker.md) *(coming soon)*
38+
39+
## Contributing
40+
41+
- [Contributing Guide](contributing.md)
42+
43+
## Support
44+
45+
- [GitHub Issues](https://github.com/trypost-it/trypost/issues) - Report bugs
46+
- [GitHub Discussions](https://github.com/trypost-it/trypost/discussions) - Ask questions

‎docs/getting-started/configuration.md‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Configuration
2+
3+
TryPost is configured through environment variables in the `.env` file.
4+
5+
## Basic Configuration
6+
7+
```env
8+
APP_NAME="TryPost"
9+
APP_ENV=local
10+
APP_DEBUG=true
11+
APP_URL=http://localhost
12+
```
13+
14+
| Variable | Description |
15+
|----------|-------------|
16+
| `APP_NAME` | Your application name |
17+
| `APP_ENV` | Environment: `local`, `staging`, `production` |
18+
| `APP_DEBUG` | Enable debug mode (set to `false` in production) |
19+
| `APP_URL` | Your application URL |
20+
21+
## Self-Hosted Mode
22+
23+
```env
24+
SELF_HOSTED=true
25+
```
26+
27+
When `SELF_HOSTED=true`, TryPost skips payment/subscription requirements. This is the default for self-hosted installations.
28+
29+
## Database
30+
31+
TryPost supports PostgreSQL and MySQL.
32+
33+
### PostgreSQL (recommended)
34+
35+
```env
36+
DB_CONNECTION=pgsql
37+
DB_HOST=127.0.0.1
38+
DB_PORT=5432
39+
DB_DATABASE=trypost
40+
DB_USERNAME=postgres
41+
DB_PASSWORD=your_password
42+
```
43+
44+
### MySQL
45+
46+
```env
47+
DB_CONNECTION=mysql
48+
DB_HOST=127.0.0.1
49+
DB_PORT=3306
50+
DB_DATABASE=trypost
51+
DB_USERNAME=root
52+
DB_PASSWORD=your_password
53+
```
54+
55+
## Redis
56+
57+
Redis is required for queues and caching.
58+
59+
```env
60+
REDIS_HOST=127.0.0.1
61+
REDIS_PASSWORD=null
62+
REDIS_PORT=6379
63+
```
64+
65+
## File Storage
66+
67+
TryPost supports local storage and S3-compatible cloud storage.
68+
69+
### Local Storage (default)
70+
71+
```env
72+
FILESYSTEM_DISK=local
73+
```
74+
75+
### AWS S3
76+
77+
```env
78+
FILESYSTEM_DISK=s3
79+
AWS_ACCESS_KEY_ID=your_key
80+
AWS_SECRET_ACCESS_KEY=your_secret
81+
AWS_DEFAULT_REGION=us-east-1
82+
AWS_BUCKET=your_bucket
83+
AWS_URL=https://your-bucket.s3.amazonaws.com
84+
```
85+
86+
### Cloudflare R2
87+
88+
```env
89+
FILESYSTEM_DISK=r2
90+
R2_ACCESS_KEY_ID=your_key
91+
R2_SECRET_ACCESS_KEY=your_secret
92+
R2_ENDPOINT=https://your-account.r2.cloudflarestorage.com
93+
R2_REGION=auto
94+
R2_BUCKET=your_bucket
95+
R2_URL=https://your-custom-domain.com
96+
```
97+
98+
### Other S3-Compatible Storage
99+
100+
Any S3-compatible storage (MinIO, DigitalOcean Spaces, etc.) can be used with the `s3` disk configuration.
101+
102+
## Mail
103+
104+
Configure your mail driver for sending emails (invites, notifications).
105+
106+
```env
107+
MAIL_MAILER=smtp
108+
MAIL_HOST=smtp.example.com
109+
MAIL_PORT=587
110+
MAIL_USERNAME=your_username
111+
MAIL_PASSWORD=your_password
112+
MAIL_ENCRYPTION=tls
113+
MAIL_FROM_ADDRESS="[email protected]"
114+
MAIL_FROM_NAME="${APP_NAME}"
115+
```
116+
117+
## Social Platforms
118+
119+
Each social platform requires API credentials. See the [Platforms documentation](../platforms/README.md) for setup instructions.
120+
121+
## Next Steps
122+
123+
- [Connect your social accounts](../platforms/README.md)
124+
- [Create your first post](first-steps.md)

‎docs/getting-started/first-steps.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# First Steps
2+
3+
After installing TryPost, follow these steps to start scheduling your social media posts.
4+
5+
## 1. Create Your Account
6+
7+
Visit your TryPost installation and click **Register** to create your account.
8+
9+
## 2. Complete Onboarding
10+
11+
After registration, you'll go through a quick onboarding process:
12+
13+
1. **Select your role** - Choose what best describes you (creator, agency, business, etc.)
14+
2. **Connect accounts** - Connect at least one social media account
15+
16+
## 3. Connect Social Accounts
17+
18+
Click on a platform to connect it:
19+
20+
- Each platform requires API credentials configured in your `.env` file
21+
- See the [Platforms documentation](../platforms/README.md) for setup instructions
22+
- You can connect multiple accounts per platform
23+
24+
## 4. Create Your First Post
25+
26+
1. Click **Create Post** or navigate to the calendar
27+
2. Write your content
28+
3. Select which accounts to post to
29+
4. Choose to post now or schedule for later
30+
5. Click **Schedule** or **Post Now**
31+
32+
## 5. Manage Your Calendar
33+
34+
The calendar view shows all your scheduled posts:
35+
36+
- Drag and drop posts to reschedule
37+
- Click a post to edit or delete it
38+
- Filter by account or status
39+
40+
## Tips
41+
42+
- **Preview your posts** - See how they'll look on each platform before publishing
43+
- **Use workspaces** - Separate different brands or clients
44+
- **Invite team members** - Collaborate with your team
45+
46+
## Next Steps
47+
48+
- [Learn about scheduling](../features/scheduling.md)
49+
- [Set up workspaces](../features/workspaces.md)
50+
- [Invite team members](../features/team.md)

‎docs/getting-started/installation.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Installation
2+
3+
This guide will walk you through installing TryPost on your server.
4+
5+
## Requirements
6+
7+
- PHP 8.2 or higher
8+
- Node.js 18 or higher
9+
- PostgreSQL 14+ or MySQL 8+
10+
- Redis
11+
- Composer
12+
13+
## Quick Install
14+
15+
### 1. Clone the repository
16+
17+
```bash
18+
git clone https://github.com/trypost-it/trypost.git
19+
cd trypost
20+
```
21+
22+
### 2. Install PHP dependencies
23+
24+
```bash
25+
composer install
26+
```
27+
28+
### 3. Install Node.js dependencies
29+
30+
```bash
31+
npm install
32+
```
33+
34+
### 4. Configure environment
35+
36+
```bash
37+
cp .env.example .env
38+
php artisan key:generate
39+
```
40+
41+
Edit the `.env` file with your database credentials and other settings. See [Configuration](configuration.md) for details.
42+
43+
### 5. Run database migrations
44+
45+
```bash
46+
php artisan migrate
47+
```
48+
49+
### 6. Build frontend assets
50+
51+
```bash
52+
npm run build
53+
```
54+
55+
### 7. Start the application
56+
57+
For development:
58+
59+
```bash
60+
# Terminal 1 - Laravel server
61+
php artisan serve
62+
63+
# Terminal 2 - Queue worker
64+
php artisan horizon
65+
66+
# Terminal 3 - Vite dev server (optional, for hot reload)
67+
npm run dev
68+
```
69+
70+
For production, configure your web server (Nginx, Apache) to serve the application.
71+
72+
## Verify Installation
73+
74+
Visit `http://localhost:8000` (or your configured domain) and you should see the TryPost welcome page.
75+
76+
## Next Steps
77+
78+
- [Configure your environment](configuration.md)
79+
- [Connect your first social account](../platforms/README.md)

‎docs/platforms/README.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Supported Platforms
2+
3+
TryPost supports the following social media platforms:
4+
5+
| Platform | Status | API Requirements |
6+
|----------|--------|------------------|
7+
| [LinkedIn](linkedin.md) | ✅ Full support | OAuth App |
8+
| [X (Twitter)](x-twitter.md) | ✅ Full support | OAuth App |
9+
| [Facebook](facebook.md) | ✅ Full support | Meta App |
10+
| [Instagram](instagram.md) | ✅ Full support | Meta App (Business account required) |
11+
| [TikTok](tiktok.md) | ✅ Full support | TikTok Developer App |
12+
| [YouTube](youtube.md) | ✅ Full support | Google Cloud Project |
13+
| [Threads](threads.md) | ✅ Full support | Meta App |
14+
| [Pinterest](pinterest.md) | ✅ Full support | Pinterest App |
15+
| [Bluesky](bluesky.md) | ✅ Full support | App Password (no OAuth) |
16+
| [Mastodon](mastodon.md) | ✅ Full support | Instance OAuth |
17+
18+
## General Setup
19+
20+
Each platform requires:
21+
22+
1. **Create a developer app** on the platform's developer portal
23+
2. **Configure OAuth credentials** in your `.env` file
24+
3. **Set the callback URL** to `{APP_URL}/accounts/{platform}/callback`
25+
26+
## Callback URLs
27+
28+
When configuring your apps, use these callback URLs (replace `https://your-domain.com` with your actual URL):
29+
30+
| Platform | Callback URL |
31+
|----------|-------------|
32+
| LinkedIn | `https://your-domain.com/accounts/linkedin/callback` |
33+
| LinkedIn Page | `https://your-domain.com/accounts/linkedin-page/callback` |
34+
| X (Twitter) | `https://your-domain.com/accounts/x/callback` |
35+
| TikTok | `https://your-domain.com/accounts/tiktok/callback` |
36+
| Facebook | `https://your-domain.com/accounts/facebook/callback` |
37+
| Instagram | `https://your-domain.com/accounts/instagram/callback` |
38+
| Threads | `https://your-domain.com/accounts/threads/callback` |
39+
| YouTube | `https://your-domain.com/accounts/youtube/callback` |
40+
| Pinterest | `https://your-domain.com/accounts/pinterest/callback` |
41+
| Mastodon | `https://your-domain.com/accounts/mastodon/callback` |
42+
43+
> **Note:** Bluesky doesn't use OAuth. You'll enter your credentials directly in TryPost.
44+
45+
## Disabling Platforms
46+
47+
You can disable specific platforms by setting environment variables:
48+
49+
```env
50+
TRYPOST_LINKEDIN_ENABLED=false
51+
TRYPOST_TIKTOK_ENABLED=false
52+
```
53+
54+
This hides the platform from the connection options.

0 commit comments

Comments
 (0)