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: instructions.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -10,15 +10,15 @@ In this exercise, you will create a system consisting of three separate but inte
10
10
11
11
## Requirements
12
12
13
-
The system you will build consists of three independent software sub-systems:
13
+
The system you will build consists of three independent software subsystems:
14
14
15
15
- a **machine learning client** - a program that performs one more more machine learning tasks on data collected from camera, microphone, or other sensor(s)
16
16
- a **web app** - an interface through which web visitors can see the activity and analytical results of the machine learning client
17
17
- a **database** - stores the data used by both other parts
18
18
19
19
A few notes:
20
20
21
-
-**What to include in this repository**: Code for the machine learning client and web app parts of this system must be stored in this "monorepo" - a single version control repository housing multiple independent subsystems of a single software project. The mongodb database will be run from mongodb's own container image, so will not be stored here, but any instructions for setting it up, running it, and populating it with starter data (if necessary) must be mentioned in the `README.md` file.
21
+
-**What to include in this repository**: Code for the machine learning client and web app parts of this system must be stored in this "monorepo" - a single version control repository housing multiple independent subsystems of a single software project. The MongoDB database will be run from MongoDB's own container image, so will not be stored here, but any instructions for setting it up, running it, and populating it with starter data (if necessary) must be mentioned in the `README.md` file.
22
22
-**What not to include in this repository**: A starter `.gitignore` file has been provided for generic Python programming. However, this should be updated as necessary to make sure that any 3rd-party libraries, modules or other dependencies used by any part of this system are not included in version control. Use `pip` or `pipenv` to document and install any 3rd-party Python software dependencies for both parts independently.
23
23
-**How to start all your containers at once**: Eventually, you must start all your system's containers together using [docker-compose](https://docs.docker.com/compose/) - a tool for starting and configuring multiple docker containers that together are necessary to run a system. However, it recommended to start running each with its own `docker` commands at first until things are more-or-less working as expected, and then integrate `docker-compose` once all parts of your system are running as expected.
24
24
@@ -151,4 +151,4 @@ Replace the contents of the [README.md](./README.md) file with a beautifully-for
151
151
- the names of all teammates as links to their GitHub profiles in the `README.md` file.
152
152
- instructions for how to configure and run all parts of your project for any developer on any platform - these instructions must work!
153
153
- instructions for how to set up any environment variables and import any starter data into the database, as necessary, for the system to operate correctly when run.
154
-
- if there are any "secret" configuration files, such as `.env` or similar files, that are not included in the version control repository, exact instructions for how to create them and what their contents should be must be supplied to the course admins by the due date.
154
+
- if there are any "secret" configuration files, such as `.env` or similar files, that are not included in the version control repository, examples of these files, such as `env.example`, with dummy data must be included in the repository and exact instructions for how to create the proper configuration files and what their contents should be must be supplied to the course admins by the due date.
0 commit comments