Notes App

A full-stack note-taking application with a desktop client built using Electron and a Node.js backend.

Project Structure

    NotesApp/ 
    ├── backend/ # Express.js server 
    └── frontend/
    └── desktop-app/ # Electron desktop client

Backend

Technologies Used

• Node.js
• Express.js
• PostgreSQL
• JSON Web Tokens (JWT)
• bcrypt
• CORS

Setup

1. Navigate to the backend directory:

cd backend

2. Install dependencies:

npm install

3. Create a .env file with the following variables:

DATABASE_URL=postgresql://username:password@localhost:5432/notesapp
JWT_SECRET=your_jwt_secret_key
PORT=3000

4. Start the server:

npm start

For development with auto-reload:

npm run dev

API Endpoints

Authentication

• POST /auth/register - Create new user account
• POST /auth/login - Login user

Notes

• GET /notes - Get all notes for authenticated user
• GET /notes/:id - Get specific note
• POST /notes - Create new note
• PUT /notes/:id - Update existing note
• DELETE /notes/:id - Delete note

Frontend (Desktop App)

Technologies Used

• Electron
• Quill.js (Rich text editor)
• Axios
• HTML/CSS/JavaScript

Features

• Rich text editing
• Floating note windows
• Auto-save functionality
• System tray integration
• User authentication
• Real-time content synchronization

Setup

1. Navigate to the desktop app directory:

cd frontend/desktop-app

2. Install dependencies:

npm install

3. Start the application:

npm start

Building the Desktop App

To create distributable packages:

npm run build

This will create platform-specific packages in the dist directory.

Development

For development with hot reload:

npm run dev

System Requirements

• Node.js 14+
• PostgreSQL 12+
• Windows, macOS, or Linux

License

ISC License

Copyright (c) 2024 Chaitu1712

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

This README provides a comprehensive overview of your project structure, setup instructions, and key features for both backend and frontend components.