NoteWave App

NoteWave is a web application for creating, editing, and managing notes.

Prerequisites

Before running the app, ensure you have the following tools and runtimes installed:

• Node.js (Version ^18.13.0 or >=20.9.0)
• npm (Version ^6.11.0 or ^7.5.6 or >=8.0.0)
• Yarn (Version >= 1.13.0)
• Docker (for running Docker Compose)

Additionally, you'll need a database visualizer tool like:

• MySQL Workbench
• DBeaver

Getting Started

To run the app locally, follow these steps:

1. Clone the repository:

git clone https://github.com/your-username/awesome-app.git

2. Navigate into the cloned directory:

cd notewave-app

3. Install dependencies using npm or yarn:

npm install

yarn install

Execute the .sh script to build and run the app:

chmod +x run.sh
./run.sh

This script will handle building the Docker images and starting the containers for you. It will also automatically stop and remove the containers when terminated.

Alternatively, if you prefer to run Docker Compose directly:

docker-compose up --build

docker-compose up -d

Once the app is up and running, you can access it at http://localhost:8080/

Additional Notes

• Please do not modify the .env file as it contains sensitive configuration information required for the app to connect to the database and function properly.

Video Demo

Demo.mov