WebBOOK

WebBOOK is a free, end-to-end encrypted MERN (MongoDB, Express.js, React.js, Node.js) application designed to revolutionize your note-taking experience. Developed with security and accessibility in mind, WebBOOK ensures that your note data is stored securely on MongoDB, allowing you to access it seamlessly from anywhere with an internet connection.

Features

• Take Notes on-the-go
• Secure
• End-to-End Encryption
• Cross platform
• Free Of Cost

Table of Contents

• WebBOOK
  • Features
  • Table of Contents
  • Installation
    • Frontend
    • Backend
  • Documentation
  • Development
    • Prerequisite
    • Frontend
    • Backend
  • Environment Variables
    • Frontend
    • Backend

Installation

Installation is simple.

Run the following command to clone the repository, and install the dependencies.

  $ git clone https://github.com/RitbanBarua/WebBOOK.git

Frontend

  $ cd webbook/Frontend
  $ npm install #or yarn install

Backend

  $ cd webbook/Backend
  $ npm install #or yarn install

Documentation

Documentation

Development

Prerequisite

• Node JS

Frontend

Go to the project directory

  cd webbook/Frontend

Install dependencies

  npm install

Start the server

  npm run start

Backend

Go to the project directory

  cd webbook/Backend

Install dependencies

  npm install

Start the server

  nodemon ./index.js

Environment Variables

To run this project, you will need to add the following environment variables to your .env file for particular project directory - one in Frontend and other one in Backend.

Frontend

REACT_APP_SECRET_CRYPTO_KEY

REACT_APP_REGISTER_URL

REACT_APP_LOGIN_URL

REACT_APP_LOGOUT_URL

REACT_APP_GET_NOTES_URL

REACT_APP_CREATE_NOTE_URL

REACT_APP_UPDATE_NOTE_URL

REACT_APP_DELETE_NOTE_URL

Backend

MongoURI

SECRET_KEY