Skip to content

This is my notebook project and I am creating it using MERN stack

Notifications You must be signed in to change notification settings

jabedalimollah/notebook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 

Repository files navigation

📓 Notebook - Secure Note-Taking Platform

Notebook is a secure, full-featured note-taking platform built with the MERN stack. It offers robust features for managing, securing, and organizing your notes, making it an ideal tool for both personal and professional use.

🔗 Live Demo

Check out the live demo of the Notebook project here.

🚀 Features

  • Secure User Authentication: Register and login with secure authentication to protect your notes.
  • Note Management: Easily create, update, and delete notes.
  • Export Options: Export your notes as PDF or TXT files for sharing or backup.
  • Clipboard Copy: Copy notes directly to your clipboard with a single click.
  • File Import: Import notes seamlessly from TXT files.
  • Advanced Search & Sorting: Quickly find and organize notes with powerful search and sorting tools.
  • Checklist Functionality: Create and manage tasks within your notes using checklists.

🛠️ Technologies Used

Client: React, Redux, TailwindCSS, Axios

Server: Node, Express

Database: MongoDB

🖥️ Installation

Prerequisites

  • Node.js and npm installed on your machine.
  • MongoDB installed and running locally or have access to a MongoDB Atlas cluster.

Clone the Repository

 git clone https://github.com/jabedalimollah/notebook.git
 cd notebook

Backend Setup

  • Navigate to the backend directory:

    cd backend
  • Install the required dependencies:

    npm install
  • Create a .env file in the backend directory and add your environment variables:

    MONGO_URI=<your_mongo_db_connection_string>
    JWT_SECRET=<your_jwt_secret_key>
    PORT=5000
    DB_NAME=<your_database_name>
    CORS_ORIGIN=<cors_origin>
  • Start the backend server

    npm run dev

Frontend Setup

  • Navigate to the frontend directory:

    cd frontend
  • Install the required dependencies:

    npm install
  • Create a .env file in the frontend directory and add your environment variables:

    VITE_APP_CONTACT_URL=<contact form url>
    VITE_APP_API_KEY=http://localhost:5000/api
  • Start the frontend development server:

    npm run dev

Running the Application

  • Ensure both the frontend and backend servers are running.
  • Open your browser and navigate to http://localhost:5173.

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

Frontend

VITE_APP_CONTACT_URL

VITE_APP_API_KEY

Backend

PORT

MONGODB_URI

DB_NAME

JWT_SECRET_KEY

CORS_ORIGIN

Logo

Screenshots

App Screenshot

App Screenshot

App Screenshot

📧 Contact

If you find this project useful, don't forget to star the repository! ⭐

🔗 Links

portfolio

linkedin

twitter