Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 2 KB

README.md

File metadata and controls

90 lines (61 loc) · 2 KB
Raw

Notes Easy - Your Notes Secured in Cloud 🔐

Introduction

Notes Easy is a cloud-based note-taking application that allows you to create, share, and collaborate on notes from anywhere.

Check out the live app!

Head over to https://noteseasy.online to experience Notes Easy in action.

Features

  • Create and edit notes: Write notes with rich text formatting, including headings, lists, and code blocks.
  • Organize your notes: Create folders and tags to categorize your notes.
  • Share your notes: Share your notes with others and collaborate on them in real-time.
  • Sync your notes: Access your notes from any device with an internet connection.
  • Secure: Your notes are securely stored in the cloud.
  • Invite collaborators and assign them roles for different access levels.
  • Version history: Track changes to your notes and revert to previous versions if needed.
  • And much more!

Technologies Used

  • Frontend: React, Material-UI, TypeScript
  • Backend: Node.js, Express.js, MongoDB
  • Real-time Collaboration: Yjs
  • Rich Text Editor: Tiptap
  • Cloud Storage: Cloudinary
  • Authentication: JSON Web Tokens (JWT)

Prerequisites

Client:

  • Node.js >= 16
  • npm or yarn
  • A text editor or IDE

Server:

  • Node.js >= 16
  • npm or yarn
  • A text editor or IDE
  • A MongoDB database

Setup

1. Clone the repository:

git clone https://github.com/your-username/NotesEasy.git
cd NotesEasy

2. Install dependencies:

Client:

cd client
npm install

Server:

cd backend
npm install

3. Create a .env file:

Copy .env.example to .env and replace the placeholders with your configuration.

4. Start the server:

npm start

5. Start the client:

npm start

6. Open your browser and navigate to http://localhost:3000

Contributing

We welcome contributions to Notes Easy.