Skip to content

romulan-overlord/JourneyPlus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About The Project

This is an expansive journalling web application with networking possible, allowing users to publish beautifully crafted entries as blogs easily accessible to their network.

What expansive journalling entails:

  • The traditional feeling of journalling is retained with the text component.
  • Add snippets of your memories not describable by words in the form of pictures, videos and audios.
  • Turn your journal entry into an experience in itself with customisable background images and background audio.
  • Collaborate with your friends to create journal entries together in real time.

Built With

  • MongoDB
  • Express
  • React
  • Node
  • Bootstrap
  • MUI
  • JQuery
  • NPM
  • Socket

Getting Started

Follow these steps to have the application running on your own device

Prerequisites

Install the following prerequisites:

  • nodeJS
  • mongoDB

Setup your mongoDB database by running mongod. The project will create a database named projectDB.

Installation

  1. Clone the repo
    git clone https://github.com/romulan-overlord/Project-1.git
  2. Install NPM packages in backend
    cd ./backend
    npm install
  3. Start up the backend server
    npm run dev
  4. Start up the socket server to allow synchronised editing:
    npm run sync
  5. Install NPM packages in frontend
    cd ./frontend
    npm install
  6. Start up the frontend server
    npm start

The website will start up on port 3000

Note: Change the url of the ExpressIP constant in settings.js in frontend to your backend server's url.

Screenshots

login Editor

Concurrent Editing

sync_example.webm

System Layout

System Layout