Browse Source

some more projects

content-update
MSilva95 3 years ago committed by Christopher Fremond
parent
commit
c6e7a476ff
  1. 38
      subjects/ascii-art-web/README.md
  2. 8
      subjects/ascii-art-web/audit/README.md
  3. 34
      subjects/ascii-art-web/dockerize/README.md
  4. 8
      subjects/ascii-art-web/dockerize/audit.md
  5. 26
      subjects/ascii-art-web/export-file/README.md
  6. 4
      subjects/ascii-art-web/export-file/audit.md
  7. 23
      subjects/ascii-art-web/stylize/README.md
  8. 6
      subjects/ascii-art-web/stylize/audit.md
  9. 2
      subjects/ascii-art/audit/README.md
  10. 2
      subjects/ascii-art/color/audit.md
  11. 2
      subjects/ascii-art/fs/audit.md
  12. 2
      subjects/ascii-art/justify/audit.md
  13. 2
      subjects/ascii-art/output/audit.md
  14. 2
      subjects/ascii-art/reverse/audit.md
  15. 22
      subjects/groupie-tracker/README.md
  16. 6
      subjects/groupie-tracker/audit/README.md
  17. 20
      subjects/groupie-tracker/filters/README.md
  18. 6
      subjects/groupie-tracker/filters/audit.md
  19. 28
      subjects/groupie-tracker/geolocalization/README.md
  20. 6
      subjects/groupie-tracker/geolocalization/audit.md
  21. 22
      subjects/groupie-tracker/search-bar/README.md
  22. 12
      subjects/groupie-tracker/search-bar/audit.md
  23. 28
      subjects/groupie-tracker/visualization/README.md
  24. 37
      subjects/groupie-tracker/visualization/audit.md
  25. 16
      subjects/groupie-tracker/visualizations/README.md
  26. 2
      subjects/groupie-tracker/visualizations/audit.md
  27. 2
      subjects/lem-in/audit/README.md
  28. 18
      subjects/my-ls-1/README.md
  29. 2
      subjects/my-ls-1/audit/README.md
  30. 37
      subjects/net-cat/README.md
  31. 14
      subjects/net-cat/audit/README.md
  32. 2
      subjects/push-swap/audit/README.md
  33. 18
      subjects/tetris-optimizer/README.md
  34. 32
      subjects/tetris-optimizer/audit/README.md

38
subjects/ascii-art-web/README.md

@ -2,51 +2,51 @@
### Objectives
Ascii-art-web consists in creating and running a server, in which it will be possible to use a web **GUI** (graphical user interface) version of your last project, [ascii-art](https://public.01-edu.org/subjects/ascii-art/).
Ascii-art-web consists in creating and running a server, in which it will be possible to use a web **GUI** (graphical user interface) version of your last project, [ascii-art](../ascii-art).
Your web-page should provide usage of different [banners](https://github.com/01-edu/public/tree/master/subjects/ascii-art).
Your webpage must allow the use of different [banners](../ascii-art).
Implement following HTTP endpoints:
Implement the following HTTP endpoints:
1. GET `/`: Sends HTML response - the main page.\
1.1. GET Tip: [go templates](https://golang.org/pkg/html/template/) to receive and display data from the server
1. GET `/`: Sends HTML response, the main page.\
1.1. GET Tip: [go templates](https://golang.org/pkg/html/template/) to receive and display data from the server.
2. POST `/ascii-art`: that sends data to Go server (text and a banner)\
2.1. POST Tip: use form and other types of [tags](https://developer.mozilla.org/en-US/docs/Web/HTML/Element) to make the post request.\
Main page must have:
The main page must have:
- text input
- radio buttons, select object or anything else to choose between banners
- button, which sends a POST request to '/ascii-art' and outputs the result on page.
- radio buttons, select object or anything else to change between banners
- button, which sends a POST request to '/ascii-art' and outputs the result on the page.
### HTTP status code
Your endpoints must return appropriate HTTP status codes.
- OK (200), if everything went without errors
- Not Found, if anything is not found, e.g: template, banner etc.
- Bad Request, for incorrect requests
- Internal Server Error, for unhandled errors
- OK (200), if everything went without errors.
- Not Found, if nothing is found, for example template or banner.
- Bad Request, for incorrect requests.
- Internal Server Error, for unhandled errors.
## Markdown
In root project directory create `README.MD` file with the following sections and contents:
In the root project directory create a `README.MD` file with the following sections and contents:
- Description
- Authors
- Usage: how to run
- Implementation details: algorithm
### Allowed packages
### Instructions
- Only the [standard go](https://golang.org/pkg/) packages are allowed
- HTTP server must be written in **Go**.
- HTML templates must be in the project root directory _templates_.
- The code must respect the [good practices](../good-practices/README.md).
### Instructions
### Allowed packages
- HTTP server must be written in _Go_.
- HTML templates must be in project root directory _templates_.
- The code must respect the [good practices](https://public.01-edu.org/subjects/good-practices/).
- Only the [standard go](https://golang.org/pkg/) packages are allowed
### Usage

8
subjects/ascii-art-web/audit/README.md

@ -90,9 +90,9 @@ o-o-o o--o o-o o o o o-o | | o o
###### Is the communication between [server and client](https://www.geeksforgeeks.org/client-server-model/) well established?
###### Does the server use the right [HTTP method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods)?
###### Does the server uses the right [HTTP method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods)?
###### Has the website runned without crashing at anytime?
###### Did the site work without crashing at any time?
###### Is the server written in Go?
@ -100,13 +100,13 @@ o-o-o o--o o-o o o o o-o | | o o
#### General
###### +Does the server present all the needed [handlers and patterns](https://golang.org/pkg/net/http/#HandleFunc) for the http requests?
###### +Does the server presents all the needed [handlers and patterns](https://golang.org/pkg/net/http/#HandleFunc) for the http requests?
#### Basic
###### +Does the server run quickly and effectively? (Favoring recursive, no unnecessary data requests, etc)
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### +Does the code obey the [good practices](../../good-practices/README.md)?
###### +Is there a test file for this code?

34
subjects/ascii-art-web/dockerize/README.md

@ -2,7 +2,7 @@
### Objectives
You must follow the same [principles](https://public.01-edu.org/subjects/ascii-art-web/) as the first subject.
You must follow the same [principles](../README.md) as the first subject.
- For this project you must create at least :
@ -14,6 +14,22 @@ You must follow the same [principles](https://public.01-edu.org/subjects/ascii-a
- You have to take caution of unused object (often referred to as "garbage collection").
### Instructions
- The web server must be created in **Go**.
- The code must respect the [good practices](../../good-practices/README.md).
- You must use Docker.
- The project must have a **Dockerfile**.
- Your Dockerfile must respect the [Dockerfile good practices](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/).
### Allowed packages
- Only the [standard go](https://golang.org/pkg/) packages are allowed
### Usage
- You can see all about Docker on [docker docs](https://docs.docker.com/).
This project will help you learn about :
- Client utilities.
@ -29,19 +45,3 @@ This project will help you learn about :
- Containerizing an application.
- Compatibility/Dependency.
- Creating images.
### Allowed packages
- Only the [standard go](https://golang.org/pkg/) packages are allowed
### Instructions
- The web server must be created in **Go**.
- The code must respect the [good practices](https://public.01-edu.org/subjects/good-practices/).
- You must use Docker.
- The project must have a **Dockerfile**.
- Your Dockerfile must respect the [Dockerfile good practices](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/).
### Usage
- You can see all about Docker on [docker docs](https://docs.docker.com/).

8
subjects/ascii-art-web/dockerize/audit.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
###### Does the project have a DockerFile?
@ -12,7 +12,7 @@ REPOSITORY TAG IMAGE ID CREA
<name of the image> latest 85a65d66ca39 7 seconds ago 795MB
```
###### Run the command `"docker images"` to see all images. Does the docker image build as above?
###### Run the command `"docker images"` to see all images. Is the docker image built as above?
##### Try running the [command](https://docs.docker.com/engine/reference/commandline/container_run/) `"docker container run [OPTIONS] IMAGE [COMMAND] [ARG...]"` to start the container using the image just created. (example : `"docker container run -p <port_you_what_to_run> --detach --name <name_of_the_container> <name_of_the_image>"`)
@ -37,7 +37,7 @@ exit
student$
```
###### Is the file system for the containers well organized?
###### Is the file system of the containers well organized?
###### Does the DockerFile contain some [metadata](https://docs.docker.com/config/labels-custom-metadata/) applied to the docker object?
@ -53,7 +53,7 @@ student$
###### +Does the server run quickly and effectively? (Favoring recursive, no unnecessary data requests, etc)
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### +Does the code obey the [good practices](../../good-practices/README.md)?
###### +Is there a test file for this code?

26
subjects/ascii-art-web/export-file/README.md

@ -2,13 +2,24 @@
### Objectives
You must follow the same [principles](https://public.01-edu.org/subjects/ascii-art-web/) as the first subject.
You must follow the same [principles](../README.md) as the first subject.
Ascii-art-web-export consists on making sure that it is possible to export the output of the web application, at least in one export format at your choice.
- You should be able to export the result of the [ascii-art](https://public.01-edu.org/subjects/ascii-art/) project implemented in the website.
- You should be able to export the result of the [ascii-art](../../ascii-art/README.md) project implemented in the website.
- The file must be exported with the right permissions (**read and write**) for the user.
### Instructions
- The web server must export at least in one export format.
- The web server must be created in **Go**.
- You must handle website errors.
- The code must respect the [good practices](../../good-practices/README.md).
### Allowed packages
- Only the [standard go](https://golang.org/pkg/) packages are allowed
This project will help you learn about :
- The basics of export formats :
@ -18,14 +29,3 @@ This project will help you learn about :
- HTTP headers
- Ways to receive data.
- Ways to output data.
### Allowed packages
- Only the [standard go](https://golang.org/pkg/) packages are allowed
### Instructions
- The web server must export at least in one export format.
- The web server must be created in **Go**.
- You must handle website errors.
- The code must respect the [good practices](https://public.01-edu.org/subjects/good-practices/).

4
subjects/ascii-art-web/export-file/audit.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
##### Try to export the file.
@ -22,7 +22,7 @@
#### Basic
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### +Does the code obey the [good practices](../../good-practices/README.md)?
###### +Are the instructions in the website clear?

23
subjects/ascii-art-web/stylize/README.md

@ -2,7 +2,7 @@
### Objectives
You must follow the same [principles](https://public.01-edu.org/subjects/ascii-art-web/) as the first subject.
You must follow the same [principles](../README.md) as the first subject.
Ascii-art-stylize consists on making your site :
@ -10,21 +10,20 @@ Ascii-art-stylize consists on making your site :
- more user friendly.
- give more feedback to the user.
This project will help you learn about:
### Instructions
- The basics of human-computer interface.
- The basics of CSS.
- Linking CSS and HTML.
- Your project must contain **CSS**.
- The code must respect the [**good practices**](../../good-practices/README.md).
- We suggest you to search for the principles of a good website design.
- It must be possible to see the text properly despite the colors used.
- The website must be [consistent](https://digitalcommunications.wp.st-andrews.ac.uk/2016/04/07/why-is-consistency-important-in-web-design/), [responsive](https://smallbiztrends.com/2013/05/what-is-responsive-web-design.html) and [interactive](https://en.m.wikipedia.org/wiki/Interactive_design).
### Allowed packages
- Only the [standard go](https://golang.org/pkg/) packages are allowed
### Instructions
- Your project must contain **CSS**.
- The code must respect the [**good practices**](https://public.01-edu.org/subjects/good-practices/).
- We suggest you to search for the principles of a good website design.
This project will help you learn about:
- It must be possible to see the text properly despite the colors used.
- The website must be [consistent](https://digitalcommunications.wp.st-andrews.ac.uk/2016/04/07/why-is-consistency-important-in-web-design/), [responsive](https://smallbiztrends.com/2013/05/what-is-responsive-web-design.html) and [interactive](https://en.m.wikipedia.org/wiki/Interactive_design).
- The basics of human-computer interface.
- The basics of CSS.
- Linking CSS and HTML.

6
subjects/ascii-art-web/stylize/audit.md

@ -1,6 +1,6 @@
#### Functional
###### Does the colors used allow you to see the text properly (ex: you can't see yellow text in a white background that well)?
###### Do the colors used allow you to see the text properly (ex: you can't see yellow text in a white background that well)?
###### Is the design [consistent](https://digitalcommunications.wp.st-andrews.ac.uk/2016/04/07/why-is-consistency-important-in-web-design/)? (examples: every page follows the same palette of colors, is all centered or is it everything aligned to the right, etc.)
@ -20,13 +20,13 @@
###### +Does the project runs quickly and effectively (Favoring of recursive, no unnecessary data requests, etc.)?
###### +Is the output of the program well structured? Does any letter seems to be out of line?
###### +Is the output of the program well structured? Is the output aligned, without any letter out of line?
###### +Is there a test file for this code?
###### +Are the tests checking each possible case?
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### +Does the code obey the [good practices](../../good-practices/README.md)?
#### Social

2
subjects/ascii-art/audit/README.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
##### Try passing as argument `"hello"`.

2
subjects/ascii-art/color/audit.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
##### Try passing as arguments `"hello world" --color=red`.

2
subjects/ascii-art/fs/audit.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
##### Try passing as arguments `"hello" standard`

2
subjects/ascii-art/justify/audit.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
##### Try passing as arguments `"left standard --align=right"`

2
subjects/ascii-art/output/audit.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
##### Try passing as arguments `"First\nTest" shadow --output=test00.txt`

2
subjects/ascii-art/reverse/audit.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
##### Try passing to the reverse flag `"--reverse=example00.txt"` the [example 00](example.md).

22
subjects/groupie-tracker/README.md

@ -14,7 +14,7 @@ Groupie Trackers consists on receiving a given API and manipulate the data conta
- And the last one, `relation`, does the link between all the other parts, `artists`, `dates` and `locations`.
- It should be used at least the `artists` and the `relation` parts given in the API.
- You must use at least the `artists` and the `relation` parts given in the API.
- Given all this you should build a user friendly website where you can display the bands info through several data visualizations (examples : blocks, cards, tables, list, pages, graphics, etc). It is up to you to decide which info you will present and how you will display it.
@ -22,24 +22,24 @@ Groupie Trackers consists on receiving a given API and manipulate the data conta
- An event consists in a system that responds to some kind of action triggered by the client, time, or any other factor.
This project will help you learn about :
- Manipulation and storage of data.
- [JSON](https://www.json.org/json-en.html) files and format.
- HTML.
- Event creation and display.
- [Events](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Events).
### Instructions
- The backend must be written in **Go**.
- The code must respect the [**good practices**](https://public.01-edu.org/subjects/good-practices/).
- The code must respect the [**good practices**](../good-practices/README.md).
- It is recommended that the code should present a **test file**.
### Allowed packages
- Only the [standard go](https://golang.org/pkg/) packages are allowed
- Only the [standard Go](https://golang.org/pkg/) packages are allowed
### Usage
- You can see an example of a RESTful API [here](https://rickandmortyapi.com/)
This project will help you learn about :
- Manipulation and storage of data.
- [JSON](https://www.json.org/json-en.html) files and format.
- HTML.
- Event creation and display.
- [Events](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Events).

6
subjects/groupie-tracker/audit/README.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
###### Is the data from the artists being used?
@ -66,7 +66,7 @@
###### Does the server use the right [HTTP method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods)?
###### Has the website runned without crashing at anytime?
###### Did the site run without crashing at any time?
###### Are all the pages working? (Absence of 404 page?)
@ -90,7 +90,7 @@
###### +Does the project runs quickly and effectively? (Favoring recursive, no unnecessary data requests, etc)
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### +Does the code obey the [good practices](../../good-practices/README.md)?
###### +Is there a test file for this code?

20
subjects/groupie-tracker/filters/README.md

@ -2,7 +2,7 @@
### Objectives
You must follow the same [principles](https://public.01-edu.org/subjects/groupie-tracker/) as the first subject.
You must follow the same [principles](../README.md) as the first subject.
- Groupie Tracker Filters consists on letting the user filter the artists/bands that will be shown.
@ -17,13 +17,6 @@ You must follow the same [principles](https://public.01-edu.org/subjects/groupie
- a range filter
- a check box filter
This project will help you learn about:
- Manipulation, display and storage of data
- Event creation and display
- JSON files and format
- Go routines
### Hints
- You have to pay attention to the locations. For example Seattle, Washington, USA **is part of** Washington, USA.
@ -32,9 +25,16 @@ This project will help you learn about:
- The backend must be written in **Go**.
- You must handle website errors.
- The code must respect the [good practices](https://public.01-edu.org/subjects/good-practices/)
- The code must respect the [good practices](../../good-practices/README.md)
- It is recommended that the code should present a **test file**.
### Allowed packages
- Only the [standard go](https://golang.org/pkg/) packages are allowed
- Only the [standard Go](https://golang.org/pkg/) packages are allowed
This project will help you learn about:
- Manipulation, display and storage of data
- Event creation and display
- JSON files and format
- Go routines

6
subjects/groupie-tracker/filters/audit.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
###### Does the project have a range [filter](https://dribbble.com/shots/1751801-Ui-Elements-Social-Network-Analytics/attachments/284260)?
@ -36,7 +36,7 @@
##### Try to filter the artists/bands that recorded their first album between `"1980"` and `"1990"` and have a maximum of `"4"` members.
###### Did it appear as a result Phll Collins, Bobby McFerrins, Red Hot Chili Peppers and Metallica?
###### Did it appear as a result Phil Collins, Bobby McFerrins, Red Hot Chili Peppers and Metallica?
###### Can you filter so that all the artists/bands are all shown?
@ -48,7 +48,7 @@
#### Basic
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### +Does the code obey the [good practices](../../good-practices/README.md)?
###### +Are the instructions in the website clear?

28
subjects/groupie-tracker/geolocalization/README.md

@ -2,34 +2,34 @@
### Objectives
You must follow the same [principles](https://public.01-edu.org/subjects/groupie-tracker/) as the first subject.
You must follow the same [principles](../README.md) as the first subject.
- Groupie Tracker Geolocation consists on mapping the different concerts locations of a certain artist/band given by the Client.
- Groupie Tracker Geolocalization consists on mapping the different concerts locations of a certain artist/band given by the Client.
- You must use a process of converting addresses (ex: Germany Mainz) into geographic coordinates (ex: 49,59380 8,15052) which you must use to place markers for the concerts locations of a certain artist/band on a map.
- You are free to use the [Map API](https://rapidapi.com/blog/top-map-apis/) you found more appropriate.
This project will help you learn about :
- Manipulation and storage of data
- HTML
- Manipulation of Maps API
- Geolocation, geocoding, etc
- [Event](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Events) creation and display
- JSON files and format
### Instructions
- The backend must be written in **Go**
- You must handle website errors
- The code must respect the [good practices](https://public.01-edu.org/subjects/good-practices/)
- The code must respect the [good practices](../../good-practices/README.md)
- It is recommended that the code should present a **test file**
### Allowed packages
- Only the [standard go](https://golang.org/pkg/) packages are allowed
- Only the [standard Go](https://golang.org/pkg/) packages are allowed
### Usage
- Here is a simple [example](https://www.google.com/maps/place/Henderson+Island/@-24.3990887,-128.3627872,13.5z/data=!4m5!3m4!1s0x9e43f2cfaa5822c5:0x58ba891a3ed4565f!8m2!3d-24.3743846!4d-128.3270931) of the process of giving a address and returning a marker to the location.
- Here is a simple [example](https://www.google.com/maps/place/Henderson+Island/@-24.3990887,-128.3627872,13.5z/data=!4m5!3m4!1s0x9e43f2cfaa5822c5:0x58ba891a3ed4565f!8m2!3d-24.3743846!4d-128.3270931) of the process of giving an address and returning a marker to the location.
This project will help you learn about :
- Manipulation and storage of data
- HTML
- Manipulation of Maps API
- Geolocation, geocoding, etc
- [Event](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Events) creation and display
- JSON files and format

6
subjects/groupie-tracker/geolocalization/audit.md

@ -1,8 +1,8 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
###### Is [geocoding](https://developers.google.com/maps/documentation/geocoding/intro) API being used to converting addresses into geographic coordinates?
###### Is [geocoding](https://developers.google.com/maps/documentation/geocoding/intro) being used to convert addresses into geographical coordinates?
##### Try to input `"Queen"` to see the concerts locations.
@ -109,7 +109,7 @@ alabama usa
#### Basic
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### +Does the code obey the [good practices](../../good-practices/README.md)?
###### +Are the instructions in the website clear?

22
subjects/groupie-tracker/search-bar/README.md

@ -2,9 +2,9 @@
### Objectives
You must follow the same [principles](https://public.01-edu.org/subjects/groupie-tracker/) as the first subject.
You must follow the same [principles](../README.md) as the first subject.
Groupie-tracker-search-bar consists of creating a functional program that searches, inside your website, for a specific input text.
Groupie tracker search bar consists of creating a functional program that searches, inside your website, for a specific input text.
- The program should handle at least these search cases :
- artist/band name
@ -17,18 +17,18 @@ Groupie-tracker-search-bar consists of creating a functional program that search
- The search bar must identify and display in each suggestion the individual type of the search cases. (ex: Freddie Mercury -> member)
- For example if you start writing `"phil"` it should appear as suggestions `Phil Collins - member` and `Phil Collins - artist/band`. This is just an example of a display.
This project will help you learn about :
- Manipulation, display and storage of data.
- HTML.
- [Events](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/) creation and display.
- JSON files and format.
### Instructions
- The program must be written in **Go**.
- The code must respect the [**good practices**](https://public.01-edu.org/subjects/good-practices/).
- The code must respect the [**good practices**](../../good-practices/README.md).
### Allowed packages
- Only the [standard go](https://golang.org/pkg/) packages are allowed
- Only the [standard Go](https://golang.org/pkg/) packages are allowed
This project will help you learn about :
- Manipulation, display and storage of data.
- HTML.
- [Events](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/) creation and display.
- JSON files and format.

12
subjects/groupie-tracker/search-bar/audit.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
##### Start typing in the search bar `"Billie Joe"`.
@ -44,25 +44,25 @@
##### Start typing an artist/band beginning with `"G"`.
###### Does it present as suggestion the band you were looking for?
###### Does the suggestion help you find the band you were looking for?
##### Start typing a location of one of the concerts.
###### Does it present as suggestion the location you were looking for?
###### Does the suggestion help you find the location you were looking for?
##### Try to search for an artist/band member beginning with `"R"`.
###### Does it present the artist/band you were looking for?
###### Does the suggestion help you find the artist/band you were looking for?
##### Try to search for a creation date of an artist/band.
###### Does it present the artist/band you were looking for?
###### Does the suggestion help you find the artist/band you were looking for?
###### As an auditor, is this project up to every standard? If not, why are you failing the project?(Empty Work, Incomplete Work, Invalid compilation, Cheating, Crashing, Leaks)
#### Basic
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### +Does the code obey the [good practices](../../good-practices/README.md)?
###### +Are the instructions in the website clear?

28
subjects/groupie-tracker/visualization/README.md

@ -1,28 +0,0 @@
## groupie-tracker-visualization
### Objectives
You must follow the same [principles](https://public.01-edu.org/subjects/groupie-tracker/) as the first subject.
Groupie-tracker-visualization consists on manipulating the data coming from the API and displaying it in the most presentable way possible to you, following the [_Schneiderman's 8 Golden Rules of Interface Design_](https://www.interaction-design.org/literature/article/shneiderman-s-eight-golden-rules-will-help-you-design-better-interfaces) :
- Strive for consistency
- Enable frequent users to use shortcuts
- Offer informative feedback
- Design dialogue to yield closure
- Offer simple error handling
- Permit easy reversal of actions
- Support internal locus of control
- Reduce short-term memory load
This project will help you learn about:
- The basics of human-computer interface.
- The basics of CSS.
- Linking CSS and HTML.
### Instructions
- Your project must contain **CSS**.
- The code must respect the [**good practices**](https://public.01-edu.org/subjects/good-practices/).
- We suggest you to search for the principles of a good website design.

37
subjects/groupie-tracker/visualization/audit.md

@ -1,37 +0,0 @@
#### Functional
###### Do the colors used allow a good visual contrast (ex: it is difficult to read a yellow text on a white background)?
###### Is the design [consistent](https://digitalcommunications.wp.st-andrews.ac.uk/2016/04/07/why-is-consistency-important-in-web-design/)? (examples: every page follows the same palette of colors, is all centered or is it everything aligned to the right, etc.)
###### Is the design [responsive](https://smallbiztrends.com/2013/05/what-is-responsive-web-design.html)? (when you change the width/ height of the page, is the site consistent?)
###### Is the [interaction design](https://en.m.wikipedia.org/wiki/Interaction_design) good (is the interface easily usable)?
##### Try to explore an inexistent page.
###### Is the design for the 404 HTTP status covered?
###### As an auditor, is this project up to every standard? If not, why are you failing the project?(Empty Work, Incomplete Work, Invalid compilation, Cheating, Crashing, Leaks)
#### General
###### +Is it easy to use the web site?
###### +Does it have a background?
#### Basic
###### +Does the project runs quickly and effectively (Favoring of recursive, no unnecessary data requests, etc.)?
###### +Is there a test file for this code?
###### +Are the tests checking each possible case?
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
#### Social
###### +Did you learn anything from this project?
###### +Would you recommend/nominate this program as an example for the rest of the school?

16
subjects/groupie-tracker/visualizations/README.md

@ -2,9 +2,9 @@
### Objectives
You must follow the same [principles](https://public.01-edu.org/subjects/groupie-tracker/) as the first subject.
You must follow the same [principles](../README.md) as the first subject.
Groupie-tracker-visualizations consists on manipulating the data coming from the API and displaying it in the most presentable way possible to you, following the [_Schneiderman's 8 Golden Rules of Interface Design_](https://www.interaction-design.org/literature/article/shneiderman-s-eight-golden-rules-will-help-you-design-better-interfaces) :
Groupie tracker visualizations consists on manipulating the data coming from the API and displaying it in the most presentable way possible to you, following the [_Schneiderman's 8 Golden Rules of Interface Design_](https://www.interaction-design.org/literature/article/shneiderman-s-eight-golden-rules-will-help-you-design-better-interfaces) :
- Strive for consistency
- Enable frequent users to use shortcuts
@ -15,14 +15,14 @@ Groupie-tracker-visualizations consists on manipulating the data coming from the
- Support internal locus of control
- Reduce short-term memory load
### Instructions
- Your project must contain **CSS**.
- The code must respect the [**good practices**](../../good-practices/README.md).
- We suggest you to search for the principles of a good website design.
This project will help you learn about:
- The basics of human-computer interface.
- The basics of CSS.
- Linking CSS and HTML.
### Instructions
- Your project must contain **CSS**.
- The code must respect the [**good practices**](https://public.01-edu.org/subjects/good-practices/).
- We suggest you to search for the principles of a good website design.

2
subjects/groupie-tracker/visualizations/audit.md

@ -28,7 +28,7 @@
###### +Are the tests checking each possible case?
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### +Does the code obey the [good practices](../../good-practices/README.md)?
#### Social

2
subjects/lem-in/audit/README.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
##### Try to run `go run . example00.txt`.

18
subjects/my-ls-1/README.md

@ -17,18 +17,10 @@
- When it comes to the `ls -l` display, it must be identical to the system command.
- Other flags displays are up to you.
This project will help you learn about :
- Unix system
- Ways to receive data.
- Ways to output data.
- Manipulation of strings.
- Manipulation of structures.
### Instructions
- Your project must be written in **Go**.
- The code must respect the [**good practices**](https://public.01-edu.org/subjects/good-practices/).
- The code must respect the [**good practices**](../good-practices/README.md).
- It is recommended that the code should present a **test file**.
### Allowed packages
@ -55,3 +47,11 @@ This project will help you learn about :
### Usage
You can see how the `ls` command works, by using it on your terminal.
This project will help you learn about :
- Unix system
- Ways to receive data.
- Ways to output data.
- Manipulation of strings.
- Manipulation of structures.

2
subjects/my-ls-1/audit/README.md

@ -108,7 +108,7 @@
#### Basic
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### +Does the code obey the [good practices](../../good-practices/README.md)?
###### +Is there a test file for this code?

37
subjects/net-cat/README.md

@ -4,11 +4,11 @@
This project consists on recreating the **NetCat in a Server-Client Architecture** that can run in a server mode on a specified port listening for incoming connections, and it can be used in client mode, trying to connect to a specified port and transmitting information to the server.
- NetCat, `nc` system command, is a computer network utility for reading from and writing to network connections using TCP or UDP. It is used for anything involving TCP, UDP, or UNIX-domain sockets, it is able to open TCP connections, send UDP packages, listen on arbitrary TCP and UDP ports...
- NetCat, `nc` system command, is a command-line utility that reads and writes data across network connections using TCP or UDP. It is used for anything involving TCP, UDP, or UNIX-domain sockets, it is able to open TCP connections, send UDP packages, listen on arbitrary TCP and UDP ports and many more.
- To see more information about NetCat inspect the manual `man nc`.
Your project must work in a similar way that NetCat works, in other words, you must create a group chat. The project must have the following features :
Your project must work in a similar way that the original NetCat works, in other words, you must create a group chat. The project must have the following features :
- TCP connection between server and multiple clients (relation of 1 to many).
- A name requirement to the client.
@ -23,18 +23,6 @@ Your project must work in a similar way that NetCat works, in other words, you m
- If a Client leaves the chat, the rest of the Clients must not disconnect.
- If there is no port specified, then set as default the port 8989. Otherwise, program must respond with usage message: `[USAGE]: ./TCPChat $port`
This project will help you learn about :
- Manipulation of structures.
- [Net-Cat](https://linuxize.com/post/netcat-nc-command-with-examples/)
- [TCP/UDP](https://www.privateinternetaccess.com/blog/2018/12/tcp-vs-udp-understanding-the-difference/)
- TCP/UDP connection
- TCP/UDP socket
- [Channels](https://tour.golang.org/concurrency/2)
- [Goroutines](https://tour.golang.org/concurrency/1)
- Mutexes
- IP and [ports](https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers)
### Instructions
- Your project must be written in **Go**
@ -42,7 +30,7 @@ This project will help you learn about :
- Your project must have Go-routines
- Your project must have channels or Mutexes
- Maximum 10 connections
- The code must respect the [**good practices**](https://public.01-edu.org/subjects/good-practices/)
- The code must respect the [**good practices**](../good-practices/README.md)
- It is recommended that the code should present a **test file** for the server connection and the client connection
- You have to be able to handle the errors from server side and client side
@ -191,6 +179,19 @@ _) \.___.,| .'
## Bonus
- Terminal UI (you are allowed to use only this package : https://github.com/jroimartin/gocui)
- Logging into the file
- Creating more than 1 group chat
- Terminal UI (you are allowed to use only this package : https://github.com/jroimartin/gocui).
- Find a way to save all the logs into a file.
- Creating more than 1 group chat.
This project will help you learn about :
- Manipulation of structures.
- [Net-Cat](https://www.commandlinux.com/man-page/man1/nc.1.html)
- TCP/UDP
- TCP/UDP connection
- TCP/UDP socket
- [Go concurrency](https://golang.org/doc/#go_concurrency_patterns)
- [Channels](https://tour.golang.org/concurrency/2)
- [Goroutines](https://tour.golang.org/concurrency/1)
- Mutexes
- IP and [ports](https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers)

14
subjects/net-cat/audit/README.md

@ -38,7 +38,7 @@
##### Try creating a server and 3 Clients and send a message using the second Client.
###### Does all the Clients (first, second and third) received the same message?
###### Did all the Clients (first, second and third) received the same message?
##### Try creating a server and use 2 or 3 different computers and create for each computer one Client.
@ -46,11 +46,11 @@
##### Try creating a server and 4 Clients and disconnect one of the Clients.
###### Does the rest of the Clients stay connected?
###### Do the rest of the Clients stay connected?
##### Try creating a server and 3 Clients and disconnect one of the Clients.
###### Does the rest of the Clients receive a message notifying that the Client left?
###### Do the rest of the Clients receive a message notifying that the Client left?
##### Try creating a server and 3 Clients. Then send messages between the Clients.
@ -64,9 +64,9 @@
###### Does the project present go routines?
###### Does the project use channels or mutexe?
###### Does the project use channels or mutexes?
##### Are the students using just the allowed functions?
##### Are the students using just the allowed packages?
###### As an auditor, is this project up to every standard? If not, why are you failing the project?(Empty Work, Incomplete Work, Invalid compilation, Cheating, Crashing, Leaks)
@ -78,7 +78,7 @@
###### +Does the server produce logs about Clients activities?
###### +Does the server logs saved into a file?
###### +Are the server logs saved into a file?
###### +Is there more NetCat flags implemented?
@ -88,7 +88,7 @@
###### +Does the project runs quickly and effectively? (Favoring recursive, no unnecessary data requests, etc)
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### +Does the code obey the [good practices](../../good-practices/README.md)?
###### +Is there a test file for this code?

2
subjects/push-swap/audit/README.md

@ -1,6 +1,6 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
##### Try to run `"./push-swap"`.

18
subjects/tetris-optimizer/README.md

@ -1,13 +1,9 @@
## tetrisoptimizer
## tetris-optimizer
### Objectives
Develop a program that receives only one argument, a path to a text file which will contain a list of [tetrominoes](https://en.wikipedia.org/wiki/Tetromino) to assemble them in order to create the smallest square possible.
### Allowed packages
- Only the [standard go](https://golang.org/pkg/) packages are allowed
### Instructions
The program must :
@ -18,13 +14,12 @@ The program must :
- Expect at least one tetromino in the text file
- In case of bad format on the tetrominoes or bad file format it should print `ERROR`
- The project must be written in **Go**.
- The code must respect the [**good practices**](https://public.01-edu.org/subjects/good-practices/).
- The code must respect the [**good practices**](../good-practices/README.md).
- It is recommended that the code should present a **test file**.
This project will help you learn about:
### Allowed packages
- The use of algorithms
- Reading from files
- Only the [standard go](https://golang.org/pkg/) packages are allowed
#### Example of a text File
@ -101,3 +96,8 @@ HHHDDG$
.HDD.G$
$
```
This project will help you learn about:
- The use of algorithms
- Reading from files

32
subjects/tetris-optimizer/audit/README.md

@ -1,62 +1,62 @@
#### Functional
###### Has the requirement for the allowed packages been respected? (Reminder for this project: (only [standard packages](https://golang.org/pkg/)
###### Has the requirement for the allowed packages been respected? (Reminder for this project: only [standard packages](https://golang.org/pkg/))
##### Try [bad example 00](https://public.01-edu.org/subjects/tetris-optimizer/badexample00).
##### Try [bad example 00](../badexample00/README.md).
`ERROR`
###### Does the program prints the value above?
##### Try [bad example 01](https://public.01-edu.org/subjects/tetris-optimizer/badexample01).
##### Try [bad example 01](../badexample01/README.md).
`ERROR`
###### Does the program prints the value above?
##### Try [bad example 02](https://public.01-edu.org/subjects/tetris-optimizer/badexample02).
##### Try [bad example 02](../badexample02/README.md).
`ERROR`
###### Does the program prints the value above?
##### Try [bad example 03](https://public.01-edu.org/subjects/tetris-optimizer/badexample03).
##### Try [bad example 03](../badexample03/README.md).
`ERROR`
###### Does the program prints the value above?
##### Try [bad example 04](https://public.01-edu.org/subjects/tetris-optimizer/badexample04).
##### Try [bad example 04](../badexample04/README.md).
`ERROR`
###### Does the program prints the value above?
##### Try [bad format](https://public.01-edu.org/subjects/tetris-optimizer/badformat).
##### Try [bad format](../badformat/README.md).
`ERROR`
###### Does the program prints the value above?
##### Try [good example 00](https://public.01-edu.org/subjects/tetris-optimizer/goodexample00).
##### Try [good example 00](../goodexample00/README.md).
###### Does the result contain 0 empty spaces (0 '.')?
##### Try [good example 01](https://public.01-edu.org/subjects/tetris-optimizer/goodexample01).
##### Try [good example 01](../goodexample01/README.md).
###### Does the result contain 9 empty spaces (9 '.')?
##### Try [good example 02](https://public.01-edu.org/subjects/tetris-optimizer/goodexample02).
##### Try [good example 02](../goodexample02/README.md).
###### Does the result contain 4 empty spaces (4 '.') and a time limit lesser or equal to the one in the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### Does the result contain 4 empty spaces (4 '.') and a time limit lesser or equal to the one in the [good practices](../../good-practices/README.md)?
##### Try [good example 03](https://public.01-edu.org/subjects/tetris-optimizer/goodexample03).
##### Try [good example 03](../goodexample03/README.md).
###### Does the result contain 5 empty spaces (5 '.') and a time limit lesser or equal to the one in the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### Does the result contain 5 empty spaces (5 '.') and a time limit lesser or equal to the one in the [good practices](../../good-practices/README.md)?
##### Try [hard example](https://public.01-edu.org/subjects/tetris-optimizer/hardexam).
##### Try [hard example](../hardexam/README.md).
###### Does the result contain 1 empty spaces (1 '.') and a time limit lesser or equal to the one in the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### Does the result contain 1 empty spaces (1 '.') and a time limit lesser or equal to the one in the [good practices](../../good-practices/README.md)?
###### Are all of the Tetrominos contained in the test file, present in the output?
@ -74,7 +74,7 @@
###### +Are the tests checking each possible case?
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/)?
###### +Does the code obey the [good practices](../../good-practices/README.md)?
#### Social

Loading…
Cancel
Save