Skip to content

Commit 66beb46

Browse files
committed
rename org
1 parent 0e76e6e commit 66beb46

1 file changed

Lines changed: 14 additions & 15 deletions

File tree

readme.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ This version is specifically for python, however the ultimate goal is to make si
88

99
- [Repository Structure](#repository-structure)
1010
- [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)
1414
- [Pre-requisites](#pre-requisites)
1515
- [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)
2121
- [Contact](#contact)
2222

2323
## Repository Structure
@@ -43,7 +43,7 @@ app/
4343
handling.py # for checking functions in tools/ work
4444
validation.py # for checking schema.json works
4545
grading.py # for checking algorithm.py works
46-
46+
4747
Dockerfile # for building whole image to deploy to AWS
4848

4949
.github/
@@ -58,9 +58,9 @@ app/
5858

5959
### Docker & Amazon Web Services (AWS)
6060

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**.
6262

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/).
6464

6565
### Middleware Functions
6666

@@ -70,7 +70,7 @@ The code needed to build the image using all the middleware functions are availa
7070

7171
### GitHub Actions
7272

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/`.
7474

7575
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.
7676

@@ -86,7 +86,7 @@ Although all programming can be done through the GitHub interface, it is recomme
8686

8787
- A code editor such as Atom, VS Code, or Sublime.
8888

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.
9090

9191
## Usage
9292

@@ -95,7 +95,7 @@ Copy this template over by clicking __Use this template__ button found in the re
9595
Begin by downloading the repository to your computer. This can be done either through GitHub Desktop or using the command:
9696

9797
```bash
98-
git clone git@github.com:Software-for-Maths-Learning/Grading-Script-Boilerplate.git
98+
git clone git@github.com:lambda-feedback/Grading-Script-Boilerplate.git
9999
```
100100

101101
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
123123
### Deployment
124124

125125
## Contact
126-

0 commit comments

Comments
 (0)