Aloha Notes 🥥

Next.JS-based note-taking application with a focus on UX and simplicity.

Getting Started

Prerequisites

Node

Development

Copy the .env.example file to .env.local and fill in the required values:

cp .env.example .env.local

Moidy the value of NEXT_PUBLIC_SESSION to a specific user session.

Run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the application.

Testing

Run the non-UI tests:

npm run test

Run the UI tests:

First, install the required dependencies:

npx playwright install

Then, run the tests:

npm run test:ui

Deployment

The application is automatically deployed to Vercel on every push to the main branch. The production version is available at https://aloha-notes.vercel.app.

About

This project was created and is maintained by Olivier Robert.

Process

The project was developed following this process:

Build a simple prototype with the core features in this branch: https://github.com/olivierobert/aloha-notes/tree/poc. This step was done to remove any technical uncertainties and to validate the core features.
Plan the final implementation with this GitHub Project: https://github.com/users/olivierobert/projects/1

Known Issues

Using a third-party for the wysiwyg editor would be easier to maintain and would provide more features, but the goal was to use as few dependencies as possible.
Positioning of the "User Mention" dropdown is based on the current mouse position, insteaf of the position of the caret.
Additional UI tests are required to validate the note editor.

olivierobert/aloha-notes