Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcnaveen/supacomments
⚡ A blazing fast, lightweight, and open source comment system for your static website, blogs powered by Supabase
https://github.com/mcnaveen/supacomments
blog comment-system comments-widget gatsby hugo jekyll producthunt supabase supabase-client supabase-js svelte tailwindcss
Last synced: 3 days ago
JSON representation
⚡ A blazing fast, lightweight, and open source comment system for your static website, blogs powered by Supabase
- Host: GitHub
- URL: https://github.com/mcnaveen/supacomments
- Owner: mcnaveen
- License: apache-2.0
- Created: 2022-04-09T17:18:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-09T04:24:50.000Z (23 days ago)
- Last Synced: 2024-12-28T23:49:38.027Z (3 days ago)
- Topics: blog, comment-system, comments-widget, gatsby, hugo, jekyll, producthunt, supabase, supabase-client, supabase-js, svelte, tailwindcss
- Language: JavaScript
- Homepage: https://supacomments.vercel.app/?ref=github-repo
- Size: 243 KB
- Stars: 138
- Watchers: 2
- Forks: 12
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## SupaComments
> 🔥 This Project will be renamed and you can expect some bigger features soon. (Updated: 16/08/2022)
> :zap: A blazing fast, lightweight, and open source comment system for your static website, blogs
### :rocket: Demo
You can visit the Below demo blog post to see the SupaComments in action.
> [https://supacomments.vercel.app/demo/](https://supacomments.vercel.app/demo/)
### :magic_wand: Lightweight
SupaComments js bundle is less than 25kb and CSS bundle is less than 5kb.
### :package: Requirements
```
Static Blog or Website
```
### :sparkles: Installation and Usage
- Clone the Repo
```
git clone https://github.com/mcnaveen/supacomments.git
```
- cd into the directory
```
cd supacomments
```
- Install dependencies
```
yarn install
```
- Configure the environment variables
```
cp .env.example .env
```
- In the [Supabase Dashboard](https://app.supabase.io) create a new project and database.
- Table name should be: `comments`
- Make sure you have the same table structure like below.
```sql
id - int8
name - text
email - text
postURL - text
comment - text
created_at - timestamp
show - boolean
```
- Default value for `show` should be `true`
- Copy API URL and Key ([Supabase Guide for Creating API URL and Key](https://supabase.com/docs/guides/api#api-url-and-keys))
- Now open the `.env` and change the values copied from the above step
> ### Example
>
> ```
> SUPACOMMENT_SUPABASE_URL=https://xxxxxxxxxxxx.supabase.co
> SUPACOMMENT_SUPABASE_ANON_KEY=xxxxxxxxxxxxxxxxx
> ```
Once you have the environment variables set, run the following command to start the build process.
```
yarn build
```
- This will create a `comments.js` & `comments.css` files under the `pubic/build` directory.
- Copy and paste the two files to root of your static website or blog.
### :pen: Usage
- To import the `comments.js` & `comments.css` file, paste the below code before `` closing tag.
```html
<link rel="stylesheet" href="./comments.css" />
```
- Then, paste the Below code where you want to show the comments.
- Change the `yoursite.com` to your website URL. (No https:// or http:// or / at the end)
- Example: `mysupacomments.com`
```html
<div id="comments" data-url="yoursite.com" clickToLoad="false"></div>
```
- Optionally, You can set the `clickToLoad` attribute to `true` to disable autoloading of comments, the User has to click Load Comments button. (Default is `false`)
Now, If you open your static website or blog, you will see the comments section like below.
### :white_check_mark: TODO/Features
- [x] Ability to add comment section based on div element
- [x] Click to load user's comments
- [ ] Add native styling instead of Tailwind CSS
- [ ] Add Docker support
- [ ] Add Reply to comment feature
- [ ] Add ability to edit and delete comment
- [ ] Add ability to add comment as logged in user or anonymous user
- [ ] Add Admin Panel for managing comments (As Monorepo)
> These are the planned features, if you have any feature request, please open an feature request on [Github](https://github.com/mcnaveen/SupaComments/issues/new?assignees=&labels=&template=feature_request.md&title=)
### :books: Contributions
Checkout the [Contributing Guide](CONTRIBUTION.md)
### Breaking Changes
:warning: Use it with caution, Breaking changes ahead!
### Disclaimer
You can add features and fixes but please don't claim this project as your own.
### :pray: Additional Information
This project uses [Supabase](https://supabase.com) for the database, [Svelte](https://svelte.dev/) for the frontend and [Tailwind CSS](https://tailwindcss.com/) for the styling and Demo is built with Next.js
### :green_heart: Message
I hope you find this project useful. If you have any questions, please create an issue.
### License
Copyright (c) 2022 [SupaComments](LICENSE)