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
+50-7Lines changed: 50 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,55 @@
1
1
# Hylo Monorepo
2
2
3
-
**THIS REPOS IN ITS CURRENT STATE WAS THE RESULT OF THESE COMMANDS:**
3
+
Thanks for checking out our code. The documentation below may be incomplete or incorrect. We welcome pull requests! But we're a very small team, so we can't guarantee timely responses.
1. Use nvm to install the correct version of node. Once installed you can just do `nvm install` to ensure the correct version is installed and then `nvm use`
12
+
13
+
2. Install yarn and foreman
14
+
15
+
```shell
16
+
npm install -g yarn foreman
17
+
```
18
+
19
+
3. Install dependencies
20
+
21
+
```shell
22
+
yarn install
23
+
```
24
+
25
+
4. Build shared packages
26
+
27
+
```shell
28
+
yarn build-packages
29
+
```
30
+
31
+
5. Backend specific setup [here](./apps/backend/README.md)
32
+
33
+
6. Web/frontend specific setup [here](./apps/web/README.md)
34
+
35
+
7. Once the back-end and front-end are setup you can run the app locally with:
36
+
Terminal 1:
37
+
```shell
38
+
yarn backend:dev
39
+
```
40
+
41
+
Terminal 2:
42
+
```shell
43
+
yarn web:dev
44
+
```
45
+
46
+
8. Mobile specific setup [here](./apps/mobile/README.md)
47
+
48
+
9. Desktop specific setup [here](./apps/desktop/README.md)
* Question: pnpm is somewhat the new hotness and shouldn't be difficult to switch to, also pnpm+nx is said to be a great combination. Do we switch to this?
48
95
49
96
Remaining work:
50
-
* Get apps/backend (hylo-node) working in a modules environment as it is a blended CommonJS and ESM project currently
51
-
* Get apps/mobile issues resolved around babel parsing emoji data, etc
52
97
* Update CircleCI configuration for web and backend, including getting yarn berry working there
53
98
* CircleCI and Bitrise triggers, etc configuration update for new paths
54
99
55
100
----
56
101
57
-
# WILL THE REAL README PLEASE STAND UP?
58
-
59
102
### Linting
60
103
61
104
Since this is a monorepo, your IDE will need to be setup to make sure the linting files for each of the apps and packages is respected.
62
105
63
-
For example, for VS Code based IDEs: https://stackoverflow.com/questions/60178254/vscode-eslint-configuration-for-a-two-projects-workspace
106
+
For example, for VS Code based IDEs: https://stackoverflow.com/questions/60178254/vscode-eslint-configuration-for-a-two-projects-workspace
Copy file name to clipboardExpand all lines: apps/backend/README.md
+3-12Lines changed: 3 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,12 @@
1
-
### hylo-node
1
+
### Hylo Backend
2
2
3
3
Thanks for checking out our code. The documentation below may be incomplete or incorrect. We welcome pull requests! But we're a very small team, so we can't guarantee timely responses.
Use nvm to install the correct version of node. Once installed you can just do `nvm install` to ensure the correct version is installed and then `nvm use`
9
+
### Setup
12
10
13
11
You need to install redis locally, then follow the steps to launch it on startup (on the default port of 6379). For OSX/MacOS:
14
12
@@ -32,13 +30,6 @@ sudo systemctl enable redis
32
30
sudo systemctl start redis
33
31
```
34
32
35
-
Next install the node modules (and Yarn, if you don't already have it available):
36
-
37
-
```shell
38
-
npm install -g foreman yarn
39
-
yarn install
40
-
```
41
-
42
33
Create a `.env` file in the root directory by copying .env.example. Values below are team specific and should be supplied as needed:
0 commit comments