Skip to content

Commit 09377f0

Browse files
committed
docs(readme): update main repo readme with new sections
1 parent 64ff8bc commit 09377f0

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -52,38 +52,38 @@ The code is in files numbered between 1 and 11, covering concepts ranging from b
5252

5353
## Section 3: Your first REST API
5454

55-
The code in this section includes a simple Flask app and a HTML and JavaScript file which calls the Flask app endpoints.
55+
The code in this section includes a simple Flask app that accepts and returns JSON data.
5656

57-
## Section 4: Flask-RESTful
57+
## Section 4: Docker
5858

59-
The code in this section includes a Flask app which is an API that represents items. It also includes user registration and authentication.
59+
Introduction to Docker to run your REST APIs. We talk about images, containers, and how to run applications.
6060

61-
We also introduce Flask-RESTful, which is a Flask extension that helps us develop APIs more easily.
61+
## Section 5: Flask-Smorest
6262

63-
## Section 5: Working with SQL
64-
65-
The code in this section extends the last section by adding persistent storage of Items to a SQLite database.
63+
We introduce the Flask-Smorest extension, a library that greatly simplifies writing REST APIs using Flask. It also provides things like automated documentation generation.
6664

6765
## Section 6: Flask-SQLAlchemy
6866

69-
The code in this section extends the previous section by replacing the manual integration with SQLite, with SQLAlchemy—an ORM (Object-Relational Mapping)—which allows us to easily replace SQLite with something like PostgreSQL or MySQL.
67+
The code in this section extends the previous section by replacing the data storage in Python lists with SQLAlchemy, an ORM (Object-Relational Mapping which simplifies connecting to and interacting with a database.
68+
69+
## Section 7: Many-to-many relationships
7070

71-
## Section 7: Git for version control
71+
In this section we talk about many-to-many relationships using SQLAlchemy.
7272

73-
In this section we introduce Git, a tool for code sharing and collaboration. In this course we'll use it to store the application code and then send it to our deployment tools, Heroku and DigitalOcean.
73+
## Section 8: Authentication with Flask-JWT-Extended
7474

75-
## Section 8: Deploying Flask Apps to Heroku
75+
Learn how to perform user authentication using JWTs and the Flask-JWT-Extended library. Here we talk about access token JWTs, as well as refresh tokens, JWT claims, blocklists, password hashing, and more.
7676

77-
Learn how to use GitHub and Heroku to deploy your Flask applications and make them available publicly to your users.
77+
## Section 9: Flask-Migrate
7878

79-
## Section 9: Deploying Flask Apps to our own servers
79+
After deploying your apps, making changes to the database can be really tricky because you have to log in to the database server and manually update the database tables using SQL commands.
8080

81-
Learn how to rent a server using DigitalOcean and run our Flask app in it. This is an alternative to Heroku. It's much cheaper, but requires a lot more work to get it set up.
81+
Flask-Migrate and the Alembic libraries simplify this job by creating migration scripts.
8282

83-
## Section 10: Security in your REST APIs
83+
## Section 10: Git Crash Course
8484

85-
In this section we learn about https and how to enable it in your own server running with DigitalOcean.
85+
A quick and intense course on Git and GitHub for code sharing.
8686

87-
## Section 11: Token Refreshing and Flask-JWT-Extended
87+
## Section 11: Deploying to Render.com
8888

89-
Learn about token freshness and how to implement refresh tokens using Flask-JWT-Extended.
89+
Learn how to get your code running in the cloud and make it publicly accessible. In this section we use Render.com for deployments and we also deploy a PostgreSQL database.

0 commit comments

Comments
 (0)