Merge pull request #64 from tecladocode/develop

Author: jslvtr

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 88
+exclude = .git,__pycache__
+max-complexity = 10

.gitignore

@@ -5,4 +5,5 @@ __pycache__/
 *.db
 .DS_Store
 venv/
-.venv/
+.venv/
+docs/docs/.nota/config.ini

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "Flask-Smorest Docker"]
+	path = project/using-flask-smorest-docker
+	url = https://github.com/tecladocode/rest-api-smorest-docker

.python-version

@@ -0,0 +1 @@
+3.10.0

.templates/lecture.md

@@ -0,0 +1,17 @@
+---
+title: The lecture title goes here
+description: A brief description of the lecture goes here.
+---
+
+- [ ] Set metadata above
+- [ ] Start writing!
+- [ ] Create `start` folder
+- [ ] Create `end` folder
+- [ ] Write TL;DR
+- [ ] Create per-file diff between `end` and `start` (use "Compare Folders")
+
+
+
+# Lecture Title
+
+

.templates/section.md

@@ -0,0 +1,7 @@
+---
+name: "Section name here"
+---
+
+# Section name here
+
+Description of the section goes here.

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# How to contribute to this course
+
+## E-book contributions
+
+### How to run the e-book
+
+Clone the repo and navigate to the `docs` folder.
+
+There, run:
+
+```
+npm install
+```
+
+Then you can run the e-book with:
+
+```
+npm run start
+```
+
+If you make any changes to the e-book, please keep changes as simple as possible and create a PR with your changes into the `develop` branch.
+
+If you are making larger changes, please create a Discussion first and let's talk about it!
+
+### Making changes to projects
+
+All the finished projects that we cover in the course are in the `projects` folder. Making changes to these projects is done very carefully, especially after recording.
+
+Please start a Discussion before making any changes, as doing so can make the experience for students confusing (if the videos and e-book are different).

README.md

@@ -36,54 +36,42 @@ If you do this for the entire course, I guarantee you will learn how to make RES
 
 ## Section 2: A Full Python Refresher
 
-The code is in files numbered between 1 and 11, covering concepts ranging from beginner to advanced.
-
-1. Variables
-2. Methods
-3. Lists, tuples, and sets
-4. If statements
-5. List comprehension
-6. Dictionaries
-7. Classes and objects
-8. Static and class methods
-9. Args and Kwargs
-10. Passing functions as arguments
-11. Decorators
+This section (only available on Udemy) helps programmers who are new to Python get acquainted with the language. It is not a complete-beginner Python course!
 
 ## Section 3: Your first REST API
 
-The code in this section includes a simple Flask app and a HTML and JavaScript file which calls the Flask app endpoints.
+The code in this section includes a simple Flask app that accepts and returns JSON data.
 
-## Section 4: Flask-RESTful
+## Section 4: Docker
 
-The code in this section includes a Flask app which is an API that represents items. It also includes user registration and authentication.
+Introduction to Docker to run your REST APIs. We talk about images, containers, and how to run applications.
 
-We also introduce Flask-RESTful, which is a Flask extension that helps us develop APIs more easily.
+## Section 5: Flask-Smorest
 
-## Section 5: Working with SQL
-
-The code in this section extends the last section by adding persistent storage of Items to a SQLite database.
+We introduce the Flask-Smorest extension, a library that greatly simplifies writing REST APIs using Flask. It also provides things like automated documentation generation.
 
 ## Section 6: Flask-SQLAlchemy
 
-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.
+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.
+
+## Section 7: Many-to-many relationships
 
-## Section 7: Git for version control
+In this section we talk about many-to-many relationships using SQLAlchemy.
 
-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.
+## Section 8: Authentication with Flask-JWT-Extended
 
-## Section 8: Deploying Flask Apps to Heroku
+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.
 
-Learn how to use GitHub and Heroku to deploy your Flask applications and make them available publicly to your users.
+## Section 9: Flask-Migrate
 
-## Section 9: Deploying Flask Apps to our own servers
+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.
 
-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.
+Flask-Migrate and the Alembic libraries simplify this job by creating migration scripts.
 
-## Section 10: Security in your REST APIs
+## Section 10: Git Crash Course
 
-In this section we learn about https and how to enable it in your own server running with DigitalOcean.
+A quick and intense course on Git and GitHub for code sharing.
 
-## Section 11: Token Refreshing and Flask-JWT-Extended
+## Section 11: Deploying to Render.com
 
-Learn about token freshness and how to implement refresh tokens using Flask-JWT-Extended.
+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.

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ npm install
+```
+
+### Local Development
+
+```
+$ npm run start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ npm run build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true npm run deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> npm run deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.