Uncensored comments, anywhere.
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.
Replies, Mentions, Upvotes and Downvotes - we have everything you need! Thanks to our voting system, you will always see the most important comments first.
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!
If you want to run any Remark application locally, follow these steps:
- Make sure all Prequerities are installed
- Follow General Setup
- Follow API, Web, Browser and/or CDN - depending on your needs!
- Want to contribute? Check CONTRIBUTING.md
- Node (nodejs.org)
- MySQL (mysql.com)
- Redis (redis.io)
- RabbitMQ (rabbitmq.com)
- Yarn (
npm i -g yarn
) - NX CLI (
yarn global add @nrwl/cli
)
- Star & Fork the repository
- Clone your fork
git clone [email protected]:USERNAME/remark.git
cd remark
- Install all dependencies
yarn
- Create global .env from template
cp .env.template .env
-
Edit
.env
to your needs -
Pull prisma
yarn prisma:dev
Use these commands to execute an action for all apps:
yarn start
yarn build
yarn lint
- Create certs
yarn certs
- Create API specific .env
cp apps/api/.env.template apps/api/.env
- Edit
apps/api/.env
to your needs!
Commands:
nx serve api
nx build api
nx lint api
- Create Web specific .env
cp apps/web/.env.template apps/api/.env.local
- Edit apps/api/.env.local to your needs!
Commands:
nx serve web
nx build web
nx lint web
- Build the extension
nx serve browser
- Open
chrome:https://extensions/
- Press "Load unpacked"
- Navigate to the remark source code and select the
build
folder inside apps/browser/ - A new extension should show up. Copy the ID shown in the extension box
- Paste the copied id into
apps/web/.env.local
as theNEXT_PUBLIC_CHROME_ID
- Enter
about:debugging
in the Firefox search bar - Navigate to the
This Firefox
tab - Press
Load Temporary Add-on
- 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
Depends on API!
- Create CDN specific .env
cp apps/cdn/.env.template apps/cdn/.env
- Edit
apps/cdn/.env
to your needs!
nx serve cdn
nx build cdn
nx lint cdn
Depends on API!
- Create WSS specific .env
cp apps/wss/.env.template apps/wss/.env
- Edit
apps/wss/.env
to your needs!
nx serve wss
nx build wss
nx lint wss
Every contribution is welcome! Learn more about how to contribute by reading the CONTRIBUTING.md
file.