hemel-cse / rengorum

:rocket: Forum app built in React, Redux & Django

Rengorum

Single-page forum application built in ReactJS and Django Rest Framework.

Live Demo: https://forum.endiliey.com/

https://youtu.be/t9vWwxydREs

Frontend

The frontend is a fast, interactive and simple Single-Page-Application (SPA), written in ES6 Javascript and built with following technologies:

• React v16
• Redux v4
• React Router v4
• Redux Thunk v2
• Redux Persist v5.9
• etc

Demo Screenshots:

Backend

The backend is a scalable system that provides data through its RESTful API (browseable API available), written in Python and built with following technologies:

• Django v2.0
• Djangorestframework v3.7
• etc

API endpoint for Demo: https://rengorum.endiliey.com/api

List of available API (browseable) at /api
* /user/
* /user/login/
* /user/register/
* /user/logout/
* /user/{username}/
* /user/{username}/edit
* /user/{username}/delete
* /forum/
* /forum/create/
* /forum/{slug}/
* /forum/{slug}/edit/
* /forum/{slug}/delete/
* /thread/
* /thread/create/
* /thread/{id}/
* /thread/{id}/edit/
* /thread/{id}/delete/
* /post/
* /post/create/
* /post/{id}/
* /post/{id}/edit/
* /post/{id}/delete/

Installation

Make sure you have following software installed in your system:

• Python 3
• Node.js
• NPM / Yarn
• Git

First, we need to clone the repository

git clone https://github.com/endiliey/rengorum.git

Install all required dependencies in an isolated environment

cd rengorum/backend
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Copy the .env.example as .env in backend folder

cp .env.example .env

Install all required dependencies for frontend in rengorum/frontend folder by typing

cd ../frontend
yarn

Copy the .env.example as .env in frontend folder

cp .env.example .env

Running Backend on Local Server

Activate virtual environment

cd backend
source venv/bin/activate

(Optional) Run test

python manage.py test

Then run the server, api endpoint should be available on http://localhost:8000/api

python manage.py runserver

Running Frontend on Local Server

Start development server

cd frontend
yarn start

Frontend should be available on http://localhost:3000/