Skip to content

Commit efca601

Browse files
authored
Update README.md
1 parent c19b4c1 commit efca601

File tree

1 file changed

+70
-17
lines changed

1 file changed

+70
-17
lines changed

README.md

Lines changed: 70 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,86 @@
11
[![Random Rants +](./wpstatic/images/randomrants-plus.svg)](https://randomrants-plus.onrender.com)
22

3-
## What is Random Rants +?
3+
# Random Rants +
44

5-
Random Rants + is the next generation of Random Rants,
6-
aimed towards having new functions and is more like an actual social media site.
7-
Random Rants + also aims for the fun of the original Random Rants, so you don't get
8-
as bored easily.
5+
> **The page nobody reads, but you should.**
96
10-
**_Glitch.com is no longer hosting projects (and that means our Random Rants + doesn't work on glitch anymore), because of that we switched to render.com to run Random Rants +._**
7+
**Random Rants +** is the next generation of Random Rants—a goofy, chaotic site that lets you hang out with your friends online. Aimed at students needing a break or anyone who enjoys small bursts of chaos, this is the place to escape reality and enter the internet.
118

12-
## Preparing Supabase enviroment variables
9+
It features video chat, soundboards, and interactive media, all designed so you don't get bored easily.
1310

14-
Create a Supabase project and provide the following enviroment vairales:
11+
> **⚠️ HOSTING UPDATE:**
12+
> **Glitch.com is no longer hosting projects.** This means our old instances don't work there anymore. We have switched to **Render.com** to run Random Rants +.
1513
16-
- sbBucket: Your Supabase storage bucket
17-
- sbAPIKey: Your Supabase secret key or api key (I recommend secret key)
18-
- sbURL: Your Supabase project url (Needs to be like `https://projectid.supabase.co`)
14+
---
1915

20-
## Installation and building
16+
## 🌟 Features
2117

22-
**_Make sure you don't skip the Supabase project stuff, as it is required to run the server._**
18+
* **Video & Voice Chat:** Powered by WebRTC (P2P). No sus servers watching your face.
19+
* **Screen Sharing:** One share per room. Expect battles for dominance.
20+
* **Chat + Commands:** Use `;help` to see owner commands.
21+
* **Soundboard:** Synced memes and goofy noises. (RIP headphone users).
22+
* **Interactive Media:** A virtual TV that handles embedded sites, shared painting canvases, and Scratch cloud mini-games (via modified TurboWarp).
23+
* **File Uploads:** Drop memes, cursed content, or files directly into the chat.
24+
* **Custom Profiles:** Change your display name, color, pfp, and fonts anytime.
2325

24-
I recommend using Node.JS 16.x, then either `git clone https://github.com/Random-Rants-Chat/randomrants-plus.git` onto your computer or download by zip.
26+
---
2527

26-
In the directory of package.json, run `npm install`. After that, use `npm run build` to build the website, and use `npm run start` to start up the server.
28+
## 🛠️ Installation & Building
2729

28-
For auto reload: Then instead of `npm run start`, use `npm run development`. Note this works for both building and server code.
30+
Want to run your own instance? Follow these steps.
2931

30-
Go to `http://localhost:3000/` to see the functional Random Rants + site in action.
32+
### 1. Prerequisites: Supabase
33+
**Do not skip this.** You must create a Supabase project to run the server.
34+
Create a project at [supabase.com](https://supabase.com) and gather the following environment variables:
35+
36+
* `sbBucket`: Your Supabase storage bucket name.
37+
* `sbAPIKey`: Your Supabase Secret Key (recommended) or API Key.
38+
* `sbURL`: Your Supabase project URL (e.g., `https://projectid.supabase.co`).
39+
40+
### 2. Local Setup
41+
I recommend using **Node.js 16.x**.
42+
43+
1. **Clone the repository:**
44+
```bash
45+
git clone [https://github.com/Random-Rants-Chat/randomrants-plus.git](https://github.com/Random-Rants-Chat/randomrants-plus.git)
46+
cd randomrants-plus
47+
```
48+
*(Or download the ZIP file and extract it).*
49+
50+
2. **Install dependencies:**
51+
```bash
52+
npm install
53+
```
54+
55+
3. **Build the website:**
56+
```bash
57+
npm run build
58+
```
59+
60+
### 3. Running the Server
61+
62+
* **Production Start:**
63+
```bash
64+
npm run start
65+
```
66+
* **Development (Auto-reload):**
67+
```bash
68+
npm run development
69+
```
70+
*Note: The development command works for both building and server code.*
71+
72+
Once running, go to `http://localhost:3000/` to see the functional Random Rants + site in action.
73+
74+
---
75+
76+
## 👥 Credits
77+
78+
* **Gvbvdxx:** Creator. Obsessed with code. Sacrificed education and homework to make this site. Banned from Scratch for making chat sites. Responsible for almost all the programming (with some help from ChatGPT & Gemini).
79+
* **MOP 3000 (aka Im_CatmanYT):** The Idea Guy. Came up with the concept of Random Rants. A 2D animator obsessed with animation.
80+
81+
---
82+
83+
## 📛 The Badge Wall
3184

3285
[![forthebadge](https://forthebadge.com/images/featured/featured-uses-html.svg)](https://forthebadge.com)
3386
[![forthebadge](https://forthebadge.com/images/featured/featured-uses-badges.svg)](https://forthebadge.com)

0 commit comments

Comments
 (0)