A dynamic note-taking system designed to foster idea connections through clusters. It harnesses artificial intelligence to intuitively link related notes, transforming information into a coherent network of interconnected ideas.
This project is developed and tested with the following versions:
- Node.js: v20.0.0 or higher
- npm: v10.0.0 or higher
- MongoDB on localhost:27017
- MinIO S3 based storage serice - docker module (https://github.com/ioak-io/docker-minio-local)
- Neuralweb Python AI module (https://github.com/ioak-io/neuralweb-ai)
- (Optional) For advanced local setup using a local instance of Authlite server,
- Authlite web application module (https://github.com/ioak-io/authlite)
- Authlite REST API service module (https://github.com/ioak-io/authlite-service)
- Clone the repository:
git clone https://github.com/ioak-io/neuralweb-service.git - Navigate to the project directory:
cd neuralweb-service - Install dependencies:
npm install
- On one terminal, run the webpack build to watch for any code changes and build when there is a code change:
npm run build:local - On another terminal, start the API server in watch mode:
npm run start:local - If you are not making any changes to the service code, you can simply run below commands to get started on a single terminal
npm run buildnpm run start
The dependencies in this project are regularly reviewed and updated. The last check for updated versions was performed on 29th Dec 2023.
To check for updates and update the dependencies, run the following command: npm outdated
This project is licensed under the MIT License.
The MIT License is a permissive open-source license that allows you to use, modify, and distribute the code, even for commercial purposes, provided you include the original copyright notice and the disclaimer of warranty.
For more information, see the MIT License file.