Giter VIP home page Giter VIP logo

aloha-notes's Introduction

Aloha Notes ๐Ÿฅฅ

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

Getting Started

Prerequisites

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:

  1. First, install the required dependencies:
npx playwright install
  1. 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:

  1. 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.
  2. 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.

aloha-notes's People

Contributors

olivierobert avatar

Watchers

 avatar

aloha-notes's Issues

As a user, I can list the most mentioned users

Why

Listing most mentioned users can make it easier for users to write their notes.

Acceptance Criteria

  • Fetch the list of most mentioned when loading the note create and update routes

Set up CD

Why

Automate deployment to Vercel

Acceptance Criteria

  • Set up project on Vercel
  • Automatically deploy on merge to main
  • Ensure deploy previews are available on pull requests

As a user, I can mention a user by drag-and-drop

Why

Make the list of most mentioned useful ๐Ÿ˜‡

Acceptance Criteria

  • Implement handlers to drag a user. The drag data to append is first_name last_name.
  • Implement handlers to drop a user into the textarea.
  • The dropped users must be inserted at the last input position.

As a user, I can update a note

Acceptance

  • Add new route to edit a note
  • Use API client to save the note
  • Redirect to the note edit page when a note is created
  • Re-use the UI created for the note creation page

Set up CI

Why

Automate feedback on linting and test errors

Acceptance Criteria

  • Set up Playwright
  • Add new test workflow
  • Add linter step
  • Add non-ui test step
  • Add ui test step

[Backend] As a user, I can mention a user from a list

Why

The application is collaborative, and a user can mention other users.

Acceptance Criteria

  • Create a new rich textarea component
  • Pass all users to mention into this component
  • Implement handler to show matched results (max 5 users). Match users on first_name and last_name.
  • Implement handler to insert a selected user into the textarea

[UI] As a user, I can mention a user from a list

Why

The UX/UI to mention users must be pleasant and easy to use.

Acceptance Criteria

  • Show list of matched users close to the caret position in the textarea
  • Implement styles to differentiate mentions from the rest of the text

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.