Merge pull request #59 from jknox927/fixing-learnpack-and-readme

Fixing learnpack and readme

Author: alesanchezr

.learn/exercises/00-intro/README.md

@@ -10,7 +10,7 @@ DELETE /todos/<int:position>
 
 ## **GET /todos** 
 
-It will return the list of all todos like this:
+It will return the list of all todos in a JSON format like this:
 
 ```javascript
 [
@@ -27,7 +27,7 @@ It will return the list of all todos like this:
 
 ## **POST /todos**
 
-It's going to add a new todo to the list by sending the following request body:
+The POST method is going to add a new todo to the list by sending the following request body:
 
 ```javascript
 {
@@ -57,4 +57,4 @@ And then, it returns the updated list of todos:
 
 ## **DELETE /todos/<int:position>**
 
-It's going to remove one todo based on a given position at the end of the url, and return the updated list of todos.
+The DELETE method is going to remove one todo based on a given position at the end of the url, and return the updated list of todos.

.learn/exercises/01-hello-world/README.md

@@ -1,6 +1,6 @@
 # Hello World with Flask 
 
-During this tutorial, we'll be building a REST API using Python programming language and the [Flask library](https://flask.palletsprojects.com/en/1.1.x/) (ideal for creating APIs).
+During this tutorial, we'll be building a REST API using the Python programming language and the [Flask library](https://flask.palletsprojects.com/en/1.1.x/) (ideal for creating APIs).
 
 But we are going to do it the right way! Following all the good practices, we have to install and learn some things first.
 
@@ -16,7 +16,7 @@ If you are building this project using Gitpod, you don't have to install anythin
 
 1. Open a new terminal (leave this one open)
 
-2. Make sure you have python version 3:
+2. Make sure you have python version 3 by running the following commands:
 
 ```bash
 $ python --version
@@ -31,7 +31,7 @@ $ python3 --version
 
 3. Make sure you have pipenv installed:
 
-Instead of using Pip and virtual env, we are going to be using Pipenv: A combination of both technologies that will make your life much easier.
+Instead of using Pip and virtual env separately, we are going to be using Pipenv: A combination of both technologies that will make your life much easier.
 
 ```bash
 $ pipenv --version

.learn/exercises/02-pipenv-installation/README.md

@@ -14,7 +14,7 @@ Every python project should be wrapped in a "virtual environment" to ensure that
 $ pipenv install --python 3
 ```
 
-You should see a **PipFile** on the root of your project and it should have inside a **[requires]** for python version 3+ similar to this one (but maybe with a different python 3 version).
+You should see a **PipFile** on the root of your project and it should have a **[requires]** inside of it for python version 3+: similar to this one (but maybe with a different python 3 version).
 
 ![Pipfile preview](../../assets/pipfile.png?raw=true)
 

.learn/exercises/03-first-flask-app/README.md

@@ -5,14 +5,14 @@ Flask is an app that behaves like a web server: it exposes (publishes) a group o
 For example, you can use Flask with a domain and expose the following URLs to the internet: 
 
 ```txt
-myporfolio.com/home
-myporfolio.com/about-me
-myporfolio.com/contact-me
+mywebsite.com/home
+mywebsite.com/about-me
+mywebsite.com/contact-me
 ```
 
-Those three URLs exposed by Flask will become your personal portfolio website.
+Those three URLs exposed by Flask will become your personal website.
 
-To create our first server, we need to add the following two lines to any python file:
+To create our first server, we need to add the following two lines to our python file that we are going to create (These two lines have to be in every flask project you create to work correctly):
 
 ```python
 from flask import Flask
@@ -22,6 +22,6 @@ app = Flask(__name__)
 
 1. On the root of your project create a `src` folder.  
 
-2. Inside of it, create a file `src/app.py`. 
+2. Inside of it, create a file named `app.py`. 
 
 3. As instructed above, add the code to create a new flask app.

.learn/exercises/03.1-app-run/README.md

@@ -2,11 +2,11 @@
 
 After creating our app, we need to run and start the application.
 
-When the application runs it will take over your command line, you will not be able to type on it anymore because a server application (like flask) never stops running, it keeps waiting for "requests" forever.
+When the application runs, it will take over your command line and you will not be able to type on it anymore because a server application (like flask) never stops running. It keeps waiting for "requests" forever.
 
 ## 📝 Instructions:
 
-1. Add the following lines to the end of your `src/app.py` file:
+1. Add the following lines at the bottom of your `app.py` file (Remember, this should be inside of your `src` folder on the root directory):
 
 ```python
 # These two lines should always be at the end of your app.py file.
@@ -16,7 +16,7 @@ if __name__ == '__main__':
 
 > These two lines should always be at the very end of your file.
 
-Run your new server by opening a **new separate terminal** and enter the following command:
+To run your new server, open a **new separate terminal** and enter the following command:
 
 ```bash
 $ pipenv run python src/app.py
@@ -25,3 +25,6 @@ $ pipenv run python src/app.py
 > Open a new terminal to run this command.
 
 ![Running Terminal](../../assets/running-flask-app.gif?raw=true)
+
+## Command Explanation:
+We use our combined `pipenv` command to start up our virtual environment and `run` it using `python`. Our target file for starting our server for future requests is our `src/app.py`.

.learn/exercises/03.2-check-for-live/README.md

@@ -1,13 +1,13 @@
 # `03.2` Check for Live URL
 
-It looks like your API is running live! 
-
-You can check it out by clicking on the URL (that was displayed on the command line) once Flask started running like this:
+You can check to see if your server is running by clicking on the URL (this is displayed on the command line) once Flask has started running like the GIF below:
 
 ![Check Flask Live](../../assets/live-api.gif?raw=true)
 
-Once you open it successfully, your live API should say `Not Found` like this:
+It looks like your API is running live!
+
+Once you open it successfully, your live API should say `Not Found` like this image:
 
 ![Not found API](../../assets/not-found.png?raw=true)
 
-The reason the API says `Not found` right now is because we have not added any endpoints so far.  Now we have to start adding endpoints!
+The reason the API says `Not found` right now is because we have not added any endpoints so far meaning, there is no data being fetched or sent. Now that we have our server up and running, let's start adding some endpoints!

.learn/exercises/03.3-your-first-route/README.md

@@ -1,28 +1,28 @@
-# `03.3` You first Endpoint (route)
+# `03.3` Creating Your First Endpoint (route)
 
-Being Flask a server, it does not make sense not to add any URLs to expose over the internet, for example:
+Since Flask is a server, it only makes sense to add some URLs to expose over the internet, for example: mydomain.com/hello
 
-As a developer, if we would like for people to visit http://mydomain.com/hello and get a message `Hello World`, we would have to add the following endpoint to the app.py file:
+As a developer, if we would like people to visit `http://mydomain.com/hello` and show a message like `Hello World` to those people, we have to add the following endpoint inside our app.py file:
 
 ```python
-@app.route('/blabla', methods=['GET'])
+@app.route('/myroute', methods=['GET'])
 def hello_world():
     return 'Hello, World!'
 ```
 
-+ The first line `@app.route('/blabla')` specifies the enpoint that will be available from now on, in this case `mydomain.com/blabla`.
++ The first part, `@app.route('/myroute')`, specifies the enpoint that will be available to our users. In this case, users would see `mydomain.com/myroute` when visiting this route.
 
-+ The first line also specifies the methods that will be used with that URL, in this case `GET` method (for reading).
++ The first line also specifies the methods that will be used with that URL. In this case, the `GET` method (for reading data).
 
 + The second line defines a function that will be called by Flask when that endpoint is called by the user (when the user requests `/blabla`).
 
-+ The third line returns the text: "Hello World" to the requesting client or browser.
++ The third line defines our function execution and in this case, returns the text "Hello World" to the requesting client or browser.
 
 ## 📝Instructions:
 
 1. Using that knowledge, make your server return the string `"<h1>Hello!</h1>"` when the URL `/todos` is typed on the browser.
 
-2. Please make sure that this lines keep being the last two lines of your `app.py` file.
+2. Please make sure that these two lines stay at the bottom of your `app.py` file. All routing and functions must remain above these two lines.
 
 ```python
 if __name__ == '__main__':

.learn/exercises/04-runnig-flask/README.md

@@ -1,11 +1,23 @@
 # `04` Demo your API!!
 
-Congratulations! Your first endpoint is LIVE now! Probably at:
+Go ahead and check your API endpoint by typing this URL on your browser and you should see the `Hello!` message like this:
+
+![Demo your API](../../assets/check-live.gif?raw=true)
+
+Congratulations! Your first endpoint is now LIVE!
+
+## Your URL will be one of two options:
+
+If running through Gitpod, just add `/todos` to the end of your URL in the browser:
+
+```txt
+GET https://yourgitpodurl:3245/todos
+```
+
+If running locally:
 
 ```txt
 GET https://localhost:3245/todos
 ```
 
-Go ahead and check for your API endpoint by typing this URL on your browser and you should see the `Hello!` message like this:
 
-![Demo your API](../../assets/check-live.gif?raw=true)

.learn/exercises/05-returning-json/README.md

@@ -9,10 +9,10 @@ You can use the [flask jsonify](https://flask.palletsprojects.com/en/1.1.x/api/#
 # add the jsonify method to your Flask import
     from flask import Flask, jsonify
 
-# suppose you have your data in the variable some_data
+# suppose you have your data in the variable named some_data
     some_data = { "name": "Bobby", "lastname": "Rixer" }
 
-@app.route('/blahblah', methods=['GET'])
+@app.route('/myroute', methods=['GET'])
 def hello_world():
     # you can convert that variable into a json string like this
     json_text = jsonify(some_data)
@@ -21,7 +21,7 @@ def hello_world():
     return json_text
 ```
 
-If we apply this knowledge to our ToDo-list project we can create a global variable `todos` that will contain the list of todos like this:
+If we apply this knowledge to our ToDo-list project, we can create a global variable named `todos` that will hold the list of todos like this:
 
 ```python
 todos = [
@@ -32,10 +32,10 @@ todos = [
 
 ## 📝Instructions:
 
-1. Create a global variable todos. Do not declare the variable inside any function, make sure to declare the variable anywhere at the global scope. Make sure the variable contains at least one task item inside with the following structure:
+1. Create a global variable called `todos`. Do not declare the variable inside any function. Declare the variable in the global scope and make sure the variable contains at least one task item (our task objects) inside with the following structure:
 
 ```python
 [ { "label": "My first task", "done": False } ]
 ```
 
-2.  Change the function that is executed on the GET method's endpoint to make it return the jsonified version of the global variable `todos`.
+2.  Change the function on the GET method's endpoint from string output so that it will return the jsonified version of the global variable `todos`.

.learn/exercises/06-check-for-live/README.md

@@ -1,5 +1,5 @@
 # `06` Check the API
 
-Now you can check your endpoint live.  It should be returning the list of todos like this:
+Now you can check your endpoint live in the browser.  It should be returning the list of todos in JSON format like this:
 
 ![check live todos](../../assets/return_todos.gif?raw=true)