Merge pull request #470 from Seluj78/env-files

Author: Seluj78

.env.template

@@ -0,0 +1,28 @@
+# To copy as .env.docker to use as docker-compose
+# Or .env for development for the backend
+
+FLASK_PORT=5000  # Flask port
+FLASK_DEBUG=true
+FLASK_HOST=0.0.0.0  # Flask host
+FLASK_SECRET_KEY=A_SECRET_KEY  # Flask secret key
+
+CELERY_BROKER_URL=redis://redis:6379/0  # Celery broker uri. Leave as is for docker
+CELERY_RESULT_BACKEND=redis://redis:6379/0  # celery results backend uri. Leave as is for docker
+
+DB_HOST=mysql  # Database host. Leave as is for docker
+DB_PORT=3306  # Database port. Leave as is for docker
+DB_USER=matcha  # Database user. Leave as is for docker
+DB_PASSWORD=matcha  # Database password. Leave as is for docker
+DB_NAME=pymatcha  # Database name. Leave as is for docker
+
+REDIS_HOST=redis  # The host of redis. Leave as is for docker
+REDIS_PORT=6379  # The port of redis. Leave as is for docker
+
+MAIL_PASSWORD=XXX  # The password of the email account pymatcha@gmail.com
+
+DEBUG_AUTH_TOKEN=XXX  # The auth token for debug routes
+
+FRONTEND_BASE_URL=localhost:4242  # The url of the frontend, used in email for links. Leave as is for docker
+
+IMGUR_CLIENT_ID=XXX  # IMGUR client id, needed to populate database if not using the dump
+IMGUR_CLIENT_SECRET=XXX  # IMGUR client secret, needed to populate database if not using the dump

README.md

@@ -22,9 +22,16 @@ Matcha is a [42](https://42.fr) school project aiming to teach how to make a dat
 You can find the subject [here](https://github.com/Seluj78/PyMatcha/blob/dev/subject.pdf)
 
 ### Installation
+
+First of all, contact [Jules](https://github.com/seluj78) or [Lauris](https://github.com/supalarry) to get the env files.
+
+For more information, checkout [the backend .env.template](https://github.com/Seluj78/PyMatcha/blob/dev/.env.template) and [the frontend .env.template](https://github.com/Seluj78/PyMatcha/blob/dev/frontend/.env.template)
+
 #### For production
 You can simply download or git clone the project and, once inside of it, run `docker-compose up --build`.
+
 The website will be accessible on port `4242`.
+
 #### For developpment
 First of all, clone or download the repository, extract it if necessary then cd into it.
 

backend/PyMatcha/routes/api/auth/login.py

@@ -33,6 +33,7 @@
 from PyMatcha.utils.decorators import validate_params
 from PyMatcha.utils.errors import NotFoundError
 from PyMatcha.utils.errors import UnauthorizedError
+from PyMatcha.utils.mail import send_mail_text
 from PyMatcha.utils.password import check_password
 from PyMatcha.utils.success import Success
 from PyMatcha.utils.success import SuccessOutput
@@ -73,6 +74,12 @@ def auth_login():
     u.is_online = True
     u.dt_lastseen = datetime.datetime.utcnow()
     u.save()
+    send_mail_text.delay(
+        dest=u.email,
+        subject="[Matcha] Login notification",
+        body=f"Someone logged in into your account at {datetime.datetime.utcnow()}."
+        f"If you believe it wasn't you, please change your password immediately!",
+    )
     ret = {"access_token": access_token, "refresh_token": refresh_token, "is_profile_completed": u.is_profile_completed}
     return SuccessOutput("return", ret)
 

backend/PyMatcha/routes/api/auth/password.py

@@ -16,6 +16,7 @@
     You should have received a copy of the GNU General Public License
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
+import datetime
 import logging
 
 from flask import Blueprint
@@ -31,6 +32,7 @@
 from PyMatcha.utils.errors import BadRequestError
 from PyMatcha.utils.errors import NotFoundError
 from PyMatcha.utils.mail import send_mail_html
+from PyMatcha.utils.mail import send_mail_text
 from PyMatcha.utils.static import FRONTEND_PASSWORD_RESET_URL
 from PyMatcha.utils.success import Success
 
@@ -87,6 +89,12 @@ def reset_password():
         u.password = hash_password(data["password"])
         u.previous_reset_token = token
         u.save()
+        send_mail_text.delay(
+            dest=u.email,
+            subject="[Matcha] Password change notification",
+            body=f"Your password was changed at {datetime.datetime.utcnow()}."
+            f"If you believe it wasn't you, please change it immediately!",
+        )
         logging.debug("Password reset successfully")
         return Success("Password reset successful.")
 

backend/PyMatcha/routes/api/profile/edit.py

@@ -212,9 +212,9 @@ def edit_password():
     current_user.save()
     send_mail_text.delay(
         dest=current_user.email,
-        subject="Password change notification",
+        subject="[Matcha] Password change notification",
         body=f"Your password was changed at {datetime.datetime.utcnow()}."
-        f"If you believe it wasn't you, please change it immediatly!",
+        f"If you believe it wasn't you, please change it immediately!",
     )
     logging.info(f"Edited email for {current_user.id}")
     return Success("User password successfully updated.")

backend/PyMatcha/routes/api/search.py

@@ -74,7 +74,7 @@ def search():
                 continue
 
         distance = _get_distance(current_user.geohash, user.geohash)
-        if distance:
+        if distance is not None:
             if distance > max_distance:
                 if max_distance != -1:
                     continue

frontend/.env.template

@@ -0,0 +1,7 @@
+# To copy as .env
+
+VUE_APP_BACKEND_BASE_URL=http://localhost:8080  # The url of the backend. Leave as is for docker
+VUE_APP_ACCESS_TOKEN=matchaAccessToken  # The tokens, default values
+VUE_APP_REFRESH_TOKEN=matchaRefreshToken  # The tokens, default values
+VUE_APP_VUEX_PERSISTED_STATE=vuex  # The name of the persisted state cookie
+VUE_APP_SECURE_LS_METADATA=_secure__ls__metadata