mimas is an open source web client that allows you to experience a simplified and efficient way to connect with the Reddit community. Vote, comment, and browse all your favorite subreddits with ease.

Self-hosted usage

Besides using mimas by visiting mimas.vercel.app you can run the app on your computer locally.

Prerequisites

Before starting, you should have installed git, Node.js (>=18.18.0), and npm.

How to start

First, you have to get a Client ID by registering your own Reddit application:

1. Go to https://old.reddit.com/prefs/apps.
2. Scroll to the bottom of the page and click on the "are you a developer? create an app..." button. The application creation form will appear.
3. Enter the value mimas (self-hosted) in the "name" field.
4. Check the "installed app" option.
5. Enter the value http://localhost:4777/auth in the "redirect uri" field.
6. Click on the "create app" button.
7. You will see the Client ID at the top of the created app card under the app name (an alphanumeric string about 20 characters long). Save it (you'll need it later).

Then clone this repository to your computer:

git clone https://github.com/vabushkevich/mimas.git

Go to the downloaded folder and install all required dependencies:

cd mimas
npm install

Copy the .env.example file to the .env file:

cp .env.example .env

Edit the .env file: replace client_id_of_your_reddit_app with the Client ID you got earlier.

Run the following command to compile required files and to start the web server:

npm start

Wait for the message "Serving!...".

Open http://localhost:4777 in your web browser.

Developing

Follow the same steps as in the "Self-hosted usage" section, but instead of executing npm start in the last step, run the following command to start the development server:

npm run dev

Wait for the message "webpack compiled successfully..." and then open http://localhost:4777 in your web browser.