Skip to content

ezecodes/notalx

Repository files navigation

NLP-Powered Notes and Task Manager

Overview

This project is a powerful note-taking application that integrates Natural Language Processing (NLP) to enhance productivity and organization. It leverages Large Language Models (LLMs) to provide intelligent note categorization, automated task extraction, and advanced contextual search capabilities.

Tech Stack

  • Frontend: React, TypeScript, Tailwind CSS
  • Backend: Node.js, Express, TypeScript
  • Build Tools: Webpack, Tailwind CSS, TypeScript Compiler
  • Database: (To be specified based on implementation)

Getting Started

Prerequisites

Make sure you have the following installed:

  • Node.js (>=14.x recommended)
  • npm (comes with Node.js)

Installation

Clone the repository:

git clone https://github.com/ezecodes/notalx.git
cd notalx

Install dependencies:

npm install

Run the development server:

npm run dev

Database Setup

Make sure you have PostgreSQL installed on your PC. You can download it from the official PostgreSQL website.

After installing PostgreSQL, you need to set up the database schema. Follow these steps:

  1. Create a new PostgreSQL database:

    createdb notalx_db
  2. Configure your database connection in the .env file:

    DB_HOST=localhost
    DB_PORT=5432
    DB_NAME=notalx_db
    DB_USER=your_postgres_user
    DB_PASSWORD=your_postgres_password
    
  3. Uncomment the sync command in the sequelize.ts file inside the src folder to seed the schema:

    // src/sequelize.ts
    import { Sequelize } from "sequelize";
    
    const sequelize = new Sequelize(
      process.env.DB_NAME,
      process.env.DB_USER,
      process.env.DB_PASSWORD,
      {
        host: process.env.DB_HOST,
        dialect: "postgres",
      }
    );
    
    // Uncomment the following line to sync the schema
    // sequelize.sync({ force: true });
    
    export default sequelize;
  4. Run the development server to apply the schema:

    npm run dev

This will set up the PostgreSQL database and apply the necessary schema for the application.

This will start both the React frontend and the Node.js backend simultaneously.

Available Scripts

  • Start the production server:

    npm start
  • Run the development server:

    npm run dev
  • Build the project:

    npm run build
  • Build individual components:

    • Build frontend: npm run build:client
    • Build backend: npm run build:server
    • Build CSS: npm run build:css
  • Watch changes in development:

    npm run dev:client  # Start frontend in watch mode
    npm run dev:server  # Start backend in watch mode
    npm run dev:css     # Watch CSS changes

Deployment

You can deploy the generated website to Render, or a custom domain by exporting the build output.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

License

MIT

Contact

For any inquiries, reach out via My site

Features

  • Text And Voice Note Support: Type text or Record audio directly in a note.
  • Full NLP-Powered Text Search: Search notes using natural language queries, including fuzzy search, synonym detection, and contextual results.
  • Task Scheduling Integration: Convert notes into tasks or reminders automatically.
  • Internal Documentation Generator: Auto-organize notes into team documentation.
  • Real-Time Collaboration and Team Spaces: Enable collaborative note-taking and task management.
  • Smart Workflow Automation: Automate workflows based on detected text patterns.

Future Enhancements

  • Website Builder from Notes: One-click transformation of notes into responsive, SEO-friendly websites.
  • AI-Powered Summarization: Automatically generate summaries of long notes.
  • Integration with Third-Party Services: Connect with services like Google Calendar, Trello, and Slack.
  • Customizable Themes: Allow users to customize the look and feel of the application.

Acknowledgements

  • Inspired by various note-taking and task management tools available in the market.

Support

If you encounter any issues or have questions, please check the FAQ or open an issue on GitHub.

Changelog

See the CHANGELOG for details on changes and updates.

See also the list of contributors who participated in this project.

About

Redefining document & notes management with Gen AI

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages