medaminefh / crappit

A less good version of Reddit developed using Node.js, React, PostgreSQL, and Typescript. Users are able to sign up, login and create posts and comment on others. Posts, like in Reddit fashion, can be upvoted or downvoted. A set of moderation tools have also been added! Design is based off of the classic Reddit layout.

Crappit

A less good version of Reddit developed using Node.js, React, PostgreSQL, and Typescript. Users are able to sign up, login and create posts/topics and comment on others. Posts and comments, like in Reddit fashion, can be upvoted or downvoted. In addition, a plethora of moderation tools have been added, allowing to secure your communities or spice up topics with custom banners/icons!

You can play around with a live build of this app here

Screenshot

not up to date, take a look at the live build for the full experience

Current Features

Crappit currently has these features:

• sign up using email or Google OAuth
• create topics, create posts for each topic, create comments for each post, create comment trees
• spice up posts with media like photos or gifs, or attach links, or use the rich text editor to write an engaging post
• upvote or downvote posts and comments
• add topics to your favourites, such that they can be accessed easily from the navbar
• post and topic moderation, you can add moderators and delete posts and comments!
• customize topics with banners and icons and also add rules to topics
• search the entire crappit database for that post you were looking for
• dark mode support

Installation

Want to run Crappit? Follow these steps:

1. Open up your terminal and install node.js. You can download it here.
2. In your terminal, cd into a directory you want to clone Crappit.
3. Follow the commands below:

git clone https://github.com/trangj/Crappit.git
cd Crappit/server
npm i
cd ../client
npm i

4. You will need to set up your process variables in order for the app to function, ensure that you have the following variables setup in .env file:

  DOMAIN: 'localhost'
  DATABASE_URL: "<your postgres database url>"
  REDIS_URL: "<your redis database url>"
  SESSION_SECRET: "<your access token secret>"
  AWS_ACCESS_KEY_ID: "<your aws access id>"
  AWS_SECRET_ACCESS_KEY: "<your aws access key>"
  GOOGLE_CLIENT_ID: "<your google id>"
  GOOGLEI_CLIENT_SECRET: "<your google secret>"
  SENDGRID_KEY: "<your sendgrid api key>"
  CLIENT_URL: "http://localhost:3000"
  SERVER_URL: "http://localhost:5000"

5. To run the server, enter the command:

npm run dev

6. Have fun!