Agrus

A Social Media MVP app based on reddit
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Configuring
   • Running
3. License
4. Contact

About The Project

Agrus is a mvp app made using MERN stack as a portfolio project.

Built With

• ReactJS
• NodeJS
• MongoDB
• TypeScirpt

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Make sure you have these install on your system.

• Git
• NodeJS

Installation

1. Clone the repo

   git clone https://github.com/siddharthroy12/Agrus

2. Install NPM packages

   npm install-all

Configuring

Create a .env file at the root of the project and fill it with these.

DB_URI=
JWT_SECRET=
NODE_ENV=development
IMGUR_CLIENT_ID=

To get the DB_URI go to mongodb atlas, create a free cluster and a database and the paste the URI here.

To get the IMGUR_CLIENT_ID go to imgur, create a new application and paste the CLIENT_ID here.

JWT_SECRET can be anything.

Running

First start the backend

npm start

Then start the client

npm client

Use 0.0.0.0:3000 instead of localhost:3000 if you are uploading video through client.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Siddharth Roy - @Siddharth_Roy12