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
+12-6Lines changed: 12 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -14,8 +14,8 @@ Cadet is the web application powering Source Academy.
14
14
15
15
### System requirements
16
16
17
-
1. Elixir 1.13.3
18
-
2. Erlang/OTP 23.2.1
17
+
1. Elixir 1.13.3+ (current version: 1.13.4)
18
+
2. Erlang/OTP 23.2.1+ (current version: 25.3.2)
19
19
3. PostgreSQL 13 or 14
20
20
21
21
It is probably okay to use a different version of PostgreSQL or Erlang/OTP, but using a different version of Elixir may result in differences in e.g. `mix format`.
@@ -29,14 +29,16 @@ It is probably okay to use a different version of PostgreSQL or Erlang/OTP, but
29
29
$ vim config/dev.secrets.exs
30
30
```
31
31
32
-
- To use NUSNET authentication, specify the NUS ADFS OAuth2 URL. (Ask for it.) Note that the frontend will supply the ADFS client ID and redirect URL (so you will need that too, but not here).
32
+
- To use NUSNET authentication, specify the NUS ADFS OAuth2 URL. (Ask for it.) Note that the frontend will supply the ADFS client ID and redirect URL (so you will need that too, but not here).
33
33
34
34
2. Install Elixir dependencies
35
35
36
36
```bash
37
37
$ mix deps.get
38
38
```
39
+
39
40
If you encounter error message `Fail to fetch record for 'hexpm/mime' from registry(using cache insted)`The following instruction may be useful for you.
41
+
40
42
```bash
41
43
$ mix local.hex --force
42
44
```
@@ -46,12 +48,16 @@ It is probably okay to use a different version of PostgreSQL or Erlang/OTP, but
46
48
```bash
47
49
$ mix ecto.setup
48
50
```
51
+
49
52
If you encounter error message about invalid password for the user "postgres".
@@ -62,7 +68,7 @@ It is probably okay to use a different version of PostgreSQL or Erlang/OTP, but
62
68
$ mix phx.server
63
69
```
64
70
65
-
5. You may now make API calls to the server locally via `localhost:4000`. The API documentation can also be accessed at http://localhost:4000/swagger.
71
+
5. You may now make API calls to the server locally via `localhost:4000`. The API documentation can also be accessed at <http://localhost:4000/swagger>.
66
72
67
73
If you don't need to test MQTT connections for remote execution using [Sling](source-academy/sling), you can stop here. Otherwise, continue to [set up the local development environment with MQTT](#setting-up-a-local-development-environment-with-mqtt-support).
68
74
@@ -110,7 +116,7 @@ In addition to performing the steps [above](#setting-up-your-local-development-e
110
116
111
117
- `get_endpoint_address` gives the address the EV3 should connect to (under normal operations). The address should be the local IP address of the computer hosting the MQTT server. Again, take note of the port number.
112
118
<details><summary>Sidenote on connecting from the EV3</summary>
113
-
119
+
114
120
We will not actually use this return value for anything, so the actual value. We just need to hardcode something to return (and stop the backend from trying to connect to AWS). Also, it is good practice to assume that the value is going to be used anyway:
115
121
</details>
116
122
@@ -138,7 +144,7 @@ $ mix help cadet.token
138
144
139
145
### Style Guide
140
146
141
-
We follow this style guide: https://github.com/lexmag/elixir-style-guide and https://github.com/christopheradams/elixir_style_guide
147
+
We follow this style guide: <https://github.com/lexmag/elixir-style-guide> and <https://github.com/christopheradams/elixir_style_guide>
142
148
143
149
Where there is a conflict between the two, the first one (lexmag) shall be the one followed.
0 commit comments