Skip to content

Commit 8d9a4d2

Browse files
committed
📝 (Add README) Overhaul README file in this repo with image
1 parent 62c9224 commit 8d9a4d2

File tree

2 files changed

+58
-8
lines changed

2 files changed

+58
-8
lines changed

README.md

Lines changed: 58 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,40 @@
11
# REST APIs with Flask and Python
22

3-
This repository contains code that is created in my course, REST APIs with Flask and Python.
3+
<p align="center">
4+
<img src="assets/course-image.png" alt="REST APIs with Flask and Python (Udemy banner image)"></a>
5+
</p>
46

5-
You can take the course here: [https://go.tecla.do/rest-apis-sale](https://go.tecla.do/rest-apis-sale)
7+
<div align="center">
68

7-
The code is divided in folders, one for each section of the course which contains code.
9+
[![Udemy rating 4.6/5](https://img.shields.io/badge/udemy-4.6%2F5-brightgreen)](https://go.tecla.do/rest-apis-sale) ![GitHub last commit](https://img.shields.io/github/last-commit/tecladocode/rest-apis-flask-python) ![Python 3.10](https://img.shields.io/badge/python-3.10-yellow) [![Discord](https://img.shields.io/discord/614395983807250433)](https://discord.gg/78Nvd3p) [![Twitter Follow](https://img.shields.io/twitter/follow/jslvtr?style=social) ](https://twitter.com/jslvtr)
810

9-
## Section 2
11+
</div>
12+
13+
---
14+
15+
<p align = "center">💡 A full course to teach you how to use Flask and Python to make REST APIs using multiple Flask extensions and PostgreSQL.</p>
16+
17+
## Getting started
18+
19+
Enrol in the course by going to [this link](https://go.tecla.do/rest-apis-sale).
20+
21+
Then you can come back here to download the repository. This repository contains the code that we develop in each section of the course.
22+
23+
If you are familiar with Git, you can use Git to download it. Otherwise, you can download it as a zip file:
24+
25+
![Download repo as a zip file](assets/download-repo-zip.png)
26+
27+
Next, start taking the course at the beginning! You can use the downloaded code files to support you while you go through the course.
28+
29+
I also **strongly recommend** you code while you take the course. A good strategy is:
30+
31+
1. Watch the video intently, optionally while taking notes.
32+
2. Watch again, more quickly, while typing the code together with me.
33+
3. Once you're done with the video, play about with the code. Make changes, break things, then fix them, and try to thoroughly understand everything the code does.
34+
35+
If you do this for the entire course, I guarantee you will learn how to make REST APIs using Flask and Python well and quickly. You'll still be using Google and searching for stuff every day, but so does everyone else!
36+
37+
## Section 2: A Full Python Refresher
1038

1139
The code is in files numbered between 1 and 11, covering concepts ranging from beginner to advanced.
1240

@@ -22,18 +50,40 @@ The code is in files numbered between 1 and 11, covering concepts ranging from b
2250
10. Passing functions as arguments
2351
11. Decorators
2452

25-
## Section 3
53+
## Section 3: Your first REST API
2654

2755
The code in this section includes a simple Flask app and a HTML and JavaScript file which calls the Flask app endpoints.
2856

29-
## Section 4
57+
## Section 4: Flask-RESTful
3058

3159
The code in this section includes a Flask app which is an API that represents items. It also includes user registration and authentication.
3260

33-
## Section 5
61+
We also introduce Flask-RESTful, which is a Flask extension that helps us develop APIs more easily.
62+
63+
## Section 5: Working with SQL
3464

3565
The code in this section extends the last section by adding persistent storage of Items to a SQLite database.
3666

37-
## Section 6
67+
## Section 6: Flask-SQLAlchemy
3868

3969
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.
70+
71+
## Section 7: Git for version control
72+
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.
74+
75+
## Section 8: Deploying Flask Apps to Heroku
76+
77+
Learn how to use GitHub and Heroku to deploy your Flask applications and make them available publicly to your users.
78+
79+
## Section 9: Deploying Flask Apps to our own servers
80+
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.
82+
83+
## Section 10: Security in your REST APIs
84+
85+
In this section we learn about https and how to enable it in your own server running with DigitalOcean.
86+
87+
## Section 11: Token Refreshing and Flask-JWT-Extended
88+
89+
Learn about token freshness and how to implement refresh tokens using Flask-JWT-Extended.

assets/course-image.png

214 KB
Loading

0 commit comments

Comments
 (0)