You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+14-15Lines changed: 14 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,16 @@ This version is specifically for python, however the ultimate goal is to make si
8
8
9
9
-[Repository Structure](#repository-structure)
10
10
-[How it works](#how-it-works)
11
-
-[Docker & Amazon Web Services (AWS)](#docker-&-amazon-web-services-aws)
12
-
-[Middleware Functions](#middleware-functions)
13
-
-[GitHub Actions](#github-actions)
11
+
-[Docker & Amazon Web Services (AWS)](#docker-&-amazon-web-services-aws)
12
+
-[Middleware Functions](#middleware-functions)
13
+
-[GitHub Actions](#github-actions)
14
14
-[Pre-requisites](#pre-requisites)
15
15
-[Usage](#usage)
16
-
-[Getting Started](#getting-started)
17
-
-[Best Practises](#best-practises)
18
-
-[Coding](#coding)
19
-
-[Testing](#testing)
20
-
-[Deployement](#deployment)
16
+
-[Getting Started](#getting-started)
17
+
-[Best Practises](#best-practises)
18
+
-[Coding](#coding)
19
+
-[Testing](#testing)
20
+
-[Deployement](#deployment)
21
21
-[Contact](#contact)
22
22
23
23
## Repository Structure
@@ -43,7 +43,7 @@ app/
43
43
handling.py # for checking functions in tools/ work
44
44
validation.py # for checking schema.json works
45
45
grading.py # for checking algorithm.py works
46
-
46
+
47
47
Dockerfile # for building whole image to deploy to AWS
48
48
49
49
.github/
@@ -58,9 +58,9 @@ app/
58
58
59
59
### Docker & Amazon Web Services (AWS)
60
60
61
-
The grading scripts are hosted AWS Lambda, using containers to run a docker image of the app. Docker is a popular tool in software development that allows programs to be hosted on any machine by bundling all its requirements and dependencies into a single file called an __image__.
61
+
The grading scripts are hosted AWS Lambda, using containers to run a docker image of the app. Docker is a popular tool in software development that allows programs to be hosted on any machine by bundling all its requirements and dependencies into a single file called an **image**.
62
62
63
-
Images are run within __containers__ on AWS, which give us a lot of flexibility over what programming language and packages/libraries can be used. For more information on Docker, read this [introduction to containerisation](https://www.freecodecamp.org/news/a-beginner-friendly-introduction-to-containers-vms-and-docker-79a9e3e119b/). To learn more about AWS Lambda, click [here](https://geekflare.com/aws-lambda-for-beginners/).
63
+
Images are run within **containers** on AWS, which give us a lot of flexibility over what programming language and packages/libraries can be used. For more information on Docker, read this [introduction to containerisation](https://www.freecodecamp.org/news/a-beginner-friendly-introduction-to-containers-vms-and-docker-79a9e3e119b/). To learn more about AWS Lambda, click [here](https://geekflare.com/aws-lambda-for-beginners/).
64
64
65
65
### Middleware Functions
66
66
@@ -70,7 +70,7 @@ The code needed to build the image using all the middleware functions are availa
70
70
71
71
### GitHub Actions
72
72
73
-
Whenever a commit is made to the GitHub repository, the new code will go through a pipeline, where it will be tested for syntax errors and code coverage. The pipeline used is called __GitHub Actions__ and the scripts for these can be found in `.github/workflows/`.
73
+
Whenever a commit is made to the GitHub repository, the new code will go through a pipeline, where it will be tested for syntax errors and code coverage. The pipeline used is called **GitHub Actions** and the scripts for these can be found in `.github/workflows/`.
74
74
75
75
On top of that, when starting a new grading script, you will have to complete a set of unit test scripts, which not only make sure your code is reliable, but also helps you to build a _specification_ for how the code should function before you start programming.
76
76
@@ -86,7 +86,7 @@ Although all programming can be done through the GitHub interface, it is recomme
86
86
87
87
- A code editor such as Atom, VS Code, or Sublime.
88
88
89
-
Copy this template over by clicking __Use this template__ button found in the repository on GitHub. Save it to the `Software-for-Maths-Learning` Organisation.
89
+
Copy this template over by clicking **Use this template** button found in the repository on GitHub. Save it to the `lambda-feedback` Organisation.
90
90
91
91
## Usage
92
92
@@ -95,7 +95,7 @@ Copy this template over by clicking __Use this template__ button found in the re
95
95
Begin by downloading the repository to your computer. This can be done either through GitHub Desktop or using the command:
Navigate into the repository folder and open `algorithm.py`. Inside is a boilerplate function called `grading_function()` which is called when a grading request is made.
@@ -123,4 +123,3 @@ An example unit test is in each file and for more information on using _unittest
0 commit comments