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
@@ -116,23 +116,23 @@ Main web app, code structure highlights:
116
116
117
117
### Setup
118
118
119
-
Please note that the development environment works completely fine on macOS and Linux only. There are a couple of minor issues on Windows, see [#521](https://github.com/igor-krupenja/zaino/issues/521) and [#522](https://github.com/igor-krupenja/zaino/issues/522).
119
+
Before starting, make sure that you have Node 16 installed or use [nvm](https://github.com/nvm-sh/nvm).
120
120
121
121
#### Common
122
122
123
123
1.[Install Google's Cloud SDK](https://cloud.google.com/sdk/docs/install) and run `gcloud auth login` to log in.
124
124
2. Run `npm install -g firebase-tools` to install Firebase CLI and run `firebase login` to log in.
125
-
3. Run `npm install` in the *root* directory of the cloned/forked repo. Running in the root directory is required because this repo uses [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces).
125
+
3. Run `npm install` in the *root* directory of the cloned/forked repo.
126
126
4. Go to [Firebase console](https://console.firebase.google.com/u/0/) and create two projects, one for **development** environment and one for **production** environment.
127
127
5. In Firebase console, create *Web* apps for the two projects you created. Refer to this [article](https://support.google.com/firebase/answer/9326094) for additional information.
128
-
6. In Firebase console, open Project Settings and note the Project IDs for the project you created.
129
-
7. Create a `.firebaserc` file in the *root* of this repo and add the Project IDs there like this:
128
+
6. In Firebase console, open Project Settings and note the Project IDs for the projects you created.
129
+
7. Create a `.firebaserc` file in the *root* of this repo and add the Project IDs there like this (dummy values):
130
130
131
131
```json
132
132
{
133
133
"projects": {
134
-
"development": "...",
135
-
"production": "..."
134
+
"development": "zaino-dev-3ea56",
135
+
"production": "zaino-prod-236c2"
136
136
}
137
137
}
138
138
```
@@ -141,22 +141,22 @@ Please note that the development environment works completely fine on macOS and
141
141
142
142
1. Go to Firebase console and open Project Settings for your projects.
143
143
2. Scroll down to Your Apps section and locate the code snippet with `firebaseConfig`.
144
-
3. Go to `packages/web-app` and create `.env.development` and `.env.production` files with the variables from `firebaseConfig`. The file format should be like this:
144
+
3. Go to `packages/web-app` and create `.env.development` and `.env.production` files with the variables from `firebaseConfig`. The file format should be like this (dummy values):
- Most of the images used in the [live demo](#live-demo) were purchased from [GraphicRiver](https://graphicriver.net/) and [Freepik](https://www.freepik.com/) and cannot be made part of this repo due to copyright restrictions. To get images in the app, you can add your own to `packages/web-app/src/images/copyrighted` directory using the following structure:
159
+
- Most of the images used in the [live demo](#live-demo) were purchased from [GraphicRiver](https://graphicriver.net/) and [Freepik](https://www.freepik.com/) and cannot be made part of this repo due to copyright restrictions. To get images in the app, you can add your own to `packages/web-app/src/images/copyrighted` directory with the following structure:
- Privacy policy content used in the [live demo](#live-demo) is not part of the repo. You can add your own to `packages/web-app/src/components/pages/PrivacyPolicy/PrivacyPolicyContent.tsx`.
2. Go to `packages/firebase` and create `.env.development` and `.env.production` files with the variables for your Project IDs. The file format should be like this:
189
191
190
192
```shell
191
-
FIREBASE_PROJECT_ID="..."
193
+
FIREBASE_PROJECT_ID="zaino-dev-3ea56"
192
194
```
193
195
194
196
Note: You can change additional settings like regions and Cloud Storage bucket name in [the `.env` file](packages/firebase/.env).
@@ -200,7 +202,8 @@ Note: You can change additional settings like regions and Cloud Storage bucket n
200
202
201
203
### Running
202
204
203
-
To start a development server running locally against a deployed development Firestore DB, go to `packages/web-app` and run `npm start`. Note that for this to work, you first need to perform steps in [Setup](#setup) and [Deployment](#deployment).
205
+
1. Make sure you did everything in [Setup](#setup) and [Deployment](#deployment).
206
+
2. Go to `packages/web-app`, run `npm start` and open [localhost:4200](http://localhost:4200). This will run against a deployed **development** Firebase project.
0 commit comments