Vacationer

In Development

A tool to help plan vacations with friends and family

Deployment Requirements:

NPM
Docker
Docker-Compose

Deployment Instructions:

1. Download repository:
   

   git clone [email protected]:johnjkenny/Vacationer.git
   cd Vacationer
   git submodule init
   git submodule update
   

2. Create an environment file in Vacationer directory. Use the following as an example:

   cat >> .env << EOF
   FLASK_APP=vacationer-app.py
   FLASK_ENV=development
   FLASK_SECRET=
   APP_AUTO_RELOAD=True
   FLASK_HOST=localhost
   FLASK_PORT=5000
   APP_DEBUG=True
   DB_HOST=db
   DB_USER=root
   DB_PASS=
   DB=vacationer
   EOF

   Use your own passwords for FLASK_SECRET and DB_PASS. Please make sure DB_PASS matches MYSQL_ROOT_PASSWORD in docker-compose.yml.

3. Update docker-compose.yml file to set MYSQL_ROOT_PASSWORD password as the same as DB_PASS variable in .env

4. Build and run dev docker containers:
   docker-compose up --build

5. Output will display running address for web application:
   web_1 | * Running on http://172.20.0.2:5000/ (Press CTRL+C to quit)
   Use address 172.20.0.2:5000/ to view application in web browser from above example.

Known Limitations

When a new user is created, an email is sent to the user with a verification code. At this time, this tool does not have email functionality and the user cannot login with their new credentials until they have verified their email address. Until a mail server container is created, please run the following commands manually to obtain verification code:

1. Connect to mysql docker container:
   docker exec -ti vacationer_db_1 mysql -u root -p
   Enter DB_PASS or MYSQL_ROOT_PASSWORD password when prompted.

2. Run query command for verification code:
   select vcode from vacationer.pend_users where uname=" ";

   Example output:

   mysql> select vcode from vacationer.pend_users where uname="awesomeOh5000";
   +--------+
   | vcode  |
   +--------+
   | 170391 |
   +--------+
   1 row in set (0.00 sec)

3. Use the vcode output as the Verification Key to validate your email address when prompted.

4. Login with the credentials you created.