Note That Down!

Welcome to Note That Down!, a stylish and functional note-taking web application that helps you keep your thoughts organized and visually appealing.

Features

1. User Authentication: Securely sign up and log in to manage your personal notes.
2. Colorful Notes: Customize your notes with a variety of colors to make them stand out.
3. Visual Layout: Enjoy a clean, masonry-style layout that arranges your notes in a dynamic and engaging way.

Technology Stack

• Backend: PHP
• Database: MariaDB

Developer Guide

To get started, clone the repository and follow the installation instructions below.

1. Clone the repository

   git clone https://github.com/yourusername/note-that-down.git
   cd note-that-down

2. Install docker along with docker-compose if not already installed
3. Set up mysql environment variables

   echo "Your-mysql-root-password-here" > secrets/mysql_root_password.txt
   echo "Your-mysql-username-here" > secrets/mysql_username.txt
   echo "Your-mysql-user-password-here" > secrets/mysql_user_password.txt

4. Start the swarm using docker-compose

   docker-compose -f docker-compose.dev.yml up -d

The web app is now running and accessible at http://localhost:80

Note: Give few minutes for mariadb container to initialize and become availble on first startup.

Production guide

1. same as developer guide, except the prod version of docker-compose command is used:

   docker-compose -f docker-compose.prod.yml up -d

Optional

The following steps are not required but might be handy for debugging

1. You can log into the database by first entering the docker container's shell

   docker exec -it <db container id or name> /bin/sh

2. Then executing the following to log into mariadb server

   mariadb -u root -p<password>

Note: Make sure to replace '< password >' and '< db container id or name >' with appropriate values