|
1 | 1 | #  Meh… |
| 2 | + |
2 | 3 | ## …another comment system |
3 | 4 |
|
4 | 5 | Meh… |
|
16 | 17 |
|
17 | 18 | Meh is a commenting system with a client-server architecture: |
18 | 19 |
|
19 | | -- **Server Component**: A PHP backend that handles comment storage (in SQLite), moderation, and API endpoints. It can be installed on your own server and supports multiple sites from a single installation. |
| 20 | +- **Server Component**: A PHP backend that handles comment storage (in SQLite), moderation, and API endpoints. It can be |
| 21 | + installed on your own server and supports multiple sites from a single installation. |
20 | 22 |
|
21 | | -- **Client Components**: A set of web components (custom HTML elements) that can be embedded in any website to display and submit comments. These components communicate with the server via a REST API. |
| 23 | +- **Client Components**: A set of web components (custom HTML elements) that can be embedded in any website to display |
| 24 | + and submit comments. These components communicate with the server via a REST API. |
22 | 25 |
|
23 | | -## Devel Quick Start |
| 26 | +## Quick Start |
24 | 27 |
|
25 | | -You can use this to get a development environment up and running quickly. This is not suitable for production use. But should answer all your questions about how Meh works. |
| 28 | +A quick and dirty way to get started is to use the built-in PHP server on your local machine. |
26 | 29 |
|
27 | | - cd backend |
28 | | - composer install |
29 | | - cd ../frontend |
30 | | - npm install |
31 | | - npm run build |
32 | | - cd .. |
33 | | - cp .env.example .env |
34 | | - $EDITOR .env |
35 | | - ./meh migrate |
36 | | - php -s localhost:8000 -t public |
| 30 | +```bash |
| 31 | +cd backend |
| 32 | +composer install |
| 33 | +cd ../frontend |
| 34 | +npm install |
| 35 | +npm run build |
| 36 | +cd .. |
| 37 | +cp .env.example .env |
| 38 | +$EDITOR .env |
| 39 | +./meh migrate |
| 40 | +php -s localhost:8000 -t public |
| 41 | +``` |
37 | 42 |
|
38 | | -You can then use `http://localhost:8000/` as the base URL for all components. |
| 43 | +You can now browse this documentation at `http://localhost:8000`. It will also serve the Meh components and the API. |
39 | 44 |
|
40 | | -## Server Setup |
| 45 | +In your blog, add the following to your HTML: |
| 46 | + |
| 47 | +```html |
| 48 | +<!-- Add a comment form --> |
| 49 | +<script type="module" src="http://localhost:8000/meh/meh.esm.js"></script> |
| 50 | + |
| 51 | +<meh-form> |
| 52 | + <meh-mastodon></meh-mastodon> |
| 53 | + <meh-login></meh-login> |
| 54 | +</meh-form> |
| 55 | +<meh-comments></meh-comments> |
| 56 | +``` |
41 | 57 |
|
| 58 | +This should give you a rough idea how Meh works. For a production setup, you should point your web server at the public. |
| 59 | + |
| 60 | +More details on how to set up the server can be found in the [Server Setup](doc/server.md) section. |
| 61 | + |
| 62 | +## Server Setup |
42 | 63 |
|
43 | 64 | * [Command Line Tool](doc/cli.md) |
44 | | -* [Database Setup and Upgrade](doc/migrate.md) |
| 65 | +* [Database Setup and Upgrade](doc/migrate.md) |
45 | 66 | * [Configuration](doc/config.md) |
46 | 67 | * [Multi-site Support](doc/multisite.md) |
47 | 68 | * [Mastodon Integration](doc/mastodon.md) |
48 | 69 | * [Email Notifications](doc/smtp.md) |
49 | 70 | * [Gravatar Integration](doc/gravatar.md) |
50 | 71 | * [Importing from Disqus](doc/disqus.md) |
51 | 72 |
|
52 | | - |
53 | 73 | ## Client Setup and Usage (on your blog) |
54 | 74 |
|
55 | 75 | * [Component Setup](doc/components.md) |
56 | | - * [Styling Components](doc/styling.md) |
| 76 | + * [Styling Components](doc/styling.md) |
57 | 77 | * [Comment Moderation](doc/moderation.md) |
58 | 78 | * [Customizing Translations](doc/translations.md) |
0 commit comments