Remark

Uncensored comments, anywhere.

Uncensored

Are your comments always getting deleted by the owner? In Remark, this is not possible anymore. Your comments can only be deleted by violating our Terms of Service.

Better

Replies, Mentions, Upvotes and Downvotes - we have everything you need! Thanks to our voting system, you will always see the most important comments first.

Anywhere

You could possibly comment anywhere you want! Even on sites that don't have a comment system. And the best of it - you can do all of that with just one account!

Development

If you want to run any Remark application locally, follow these steps:

1. Make sure all Prequerities are installed
2. Follow General Setup
3. Follow API, Web, Browser and/or CDN - depending on your needs!
4. Want to contribute? Check CONTRIBUTING.md

Prequerities

1. Node (nodejs.org)
2. MySQL (mysql.com)
3. Redis (redis.io)
4. RabbitMQ (rabbitmq.com)
5. Yarn (npm i -g yarn)
6. NX CLI (yarn global add @nrwl/cli)

General Setup

1. Star & Fork the repository

2. Clone your fork

git clone [email protected]:USERNAME/remark.git
cd remark

3. Install all dependencies

yarn

4. Create global .env from template

cp .env.template .env

5. Edit .env to your needs

6. Pull prisma

yarn prisma:dev

Use these commands to execute an action for all apps:

yarn start
yarn build
yarn lint

API Setup

1. Create certs

yarn certs

2. Create API specific .env

cp apps/api/.env.template apps/api/.env

3. Edit apps/api/.env to your needs!

Commands:

nx serve api
nx build api
nx lint api

Web Setup

1. Create Web specific .env

cp apps/web/.env.template apps/api/.env.local

2. Edit apps/api/.env.local to your needs!

Commands:

nx serve web
nx build web
nx lint web

Browser Setup

Depends on Web and API! CDN is recommended.

1. Build the extension

nx serve browser

Chrome (or chromium based)

2. Open chrome://extensions/
3. Press "Load unpacked"
4. Navigate to the remark source code and select the build folder inside apps/browser/
5. A new extension should show up. Copy the ID shown in the extension box
6. Paste the copied id into apps/web/.env.local as the NEXT_PUBLIC_CHROME_ID

Firefox

2. Enter about:debugging in the Firefox search bar
3. Navigate to the This Firefox tab
4. Press Load Temporary Add-on
5. Navigate to the remark source code and select the manifest.json file inside apps/browser/build

Commands:

nx serve browser
nx build browser
nx lint browser

CDN Setup

Depends on API!

1. Create CDN specific .env

cp apps/cdn/.env.template apps/cdn/.env

2. Edit apps/cdn/.env to your needs!

nx serve cdn
nx build cdn
nx lint cdn

WSS Setup

Depends on API!

1. Create WSS specific .env

cp apps/wss/.env.template apps/wss/.env

2. Edit apps/wss/.env to your needs!

nx serve wss
nx build wss
nx lint wss

Contribute

Every contribution is welcome! Learn more about how to contribute by reading the CONTRIBUTING.md file.