add migrations folder to .gitignore / add shortcut command to downgrade migrations / add new CLI to flask to help students persisting example data in their database / update documentation with information for new functionalities

Author: leomuzicarvalho

.gitignore

@@ -75,6 +75,7 @@ dist/*
 .now
 
 # backend stuff
+migrations/
 .venv
 database.database
 database.db

Pipfile

@@ -28,5 +28,7 @@ init="flask db init"
 migrate="flask db migrate"
 local="heroku local"
 upgrade="flask db upgrade"
+downgrade="flask db downgrade"
+insert-test-data="flask insert-test-data"
 reset_db="bash ./docs/assets/reset_migrations.bash"
 deploy="echo 'Please follow this 3 steps to deploy: https://github.com/4GeeksAcademy/flask-rest-hello/blob/master/README.md#deploy-your-website-to-heroku' "

README.md

@@ -31,6 +31,14 @@ It is recomended to install the backend first, make sure you have Python 3.8, Pi
 
 > Note: Codespaces users can connect to psql by typing: `psql -h localhost -U gitpod example`
 
+### Undo a migration
+
+You are also able to undo a migration by running
+
+```sh
+$ pipenv run downgrade
+```
+
 ### Backend Populate Table Users
 
 To insert test users in the database execute the following command:
@@ -51,7 +59,9 @@ And you will see the following message:
   Users created successfully!
 ```
 
-To update with all yours tables you can edit the file app.py and go to the line 80 to insert the code to populate others tables
+### **Important note for the database and the data inside it**
+
+Every Github codespace environment will have **its own database**, so if you're working with more people eveyone will have a different database and different records inside it. This data **will be lost**, so don't spend too much time manually creating records for testing, instead, you can automate adding records to your database by editing ```commands.py``` file inside ```/src/api``` folder. Edit line 32 function ```insert_test_data``` to insert the data according to your model (use the function ```insert_test_users``` above as an example). Then, all you need to do is run ```pipenv run insert-test-data```.
 
 ### Front-End Manual Installation:
 

src/api/commands.py

@@ -16,7 +16,7 @@ def setup_commands(app):
     """
     @app.cli.command("insert-test-users") # name of our command
     @click.argument("count") # argument of out command
-    def insert_test_data(count):
+    def insert_test_users(count):
         print("Creating test users")
         for x in range(1, int(count) + 1):
             user = User()
@@ -29,4 +29,6 @@ def insert_test_data(count):
 
         print("All test users created")
 
-        ### Insert the code to populate others tables if needed
+    @app.cli.command("insert-test-data")
+    def insert_test_data():
+        pass