Skip to content

Commit c8fad34

Browse files
committed
fix: update installation documentation
fix: update readme fix : readme
1 parent 9137111 commit c8fad34

5 files changed

Lines changed: 40 additions & 13 deletions

File tree

README.md

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,23 +44,48 @@ React guidelines:
4444

4545
### Requirements
4646

47-
- One firebase project for **`open planner`**.
47+
- One Firebase project for **`OpenPlanner`** on the Blaze plan.
4848
- Node.js **20+**
4949
- [Bun.js](https://bun.js.org/) as a build tool
5050

5151
### Installation
5252

53-
1. Create a **`.env`** with **`.env.example`** as a template.
54-
2. Create a web app in your firebase project for **`conference hall`** and **`open planner`**. then copy the config and fill **`.env`** with it.
55-
3. Use [bun.sh](https://bun.sh/) to install dependencies and build the project: `bun install`
53+
1. Create a `.env` from `.env.example`. Do the same for the `.env` files in `functions` .
54+
2. In your Firebase project, create a **web app** with Firebase Hosting named `openplanner`. Copy the generated config and populate `.env`.
55+
For the API URL, create a **Function** named `api` and copy its trigger URL into the env file.
56+
3. Create the following **web app**, each with its own Hosting site (replace `X` with your suffix):
57+
- API: Hosting site `apiopenplannerX`
58+
- ConferenceCenter: Hosting site `conferencecenterrX`
59+
- ServiceApi: Hosting site `serviceapiX`
60+
4. Update `firebase.json` so the `site` value matches the correct Hosting site name for the target you are deploying.
61+
5. Install dependencies with Bun: `bun install`.
5662

5763
Inside OpenPlanner's firebase project:
5864

59-
1. Enable Authentication with email/pwd in console.firebase.google.com
60-
2. In the Authentication parameters, "User actions", disable the "Protection against enumeration of e-mail addresses (recommended)" option
61-
3. Enable Storage, with rules in test or prod (whatever)
62-
4. Set the hosting config for the website using the firebase CLI: `firebase target:apply hosting conferencecenterr dist`
63-
5. Set the hosting config for the API (swagger) `firebase target:apply hosting apiopenplanner api-swagger`
65+
1. Enable Authentication with email/password (Authentication > Sign-in method > Email/Password > Enable).
66+
2. In Authentication settings, under User actions, disable “Protection against email enumeration (recommended)”.
67+
3. Create Storage (use test or prod rules as needed).
68+
4. Create a Firestore database (default mode).
69+
5. Log in and select the Firebase project in your terminal:
70+
71+
```
72+
firebase login
73+
firebase use openplanner
74+
```
75+
76+
6. Configure hosting targets with the Firebase CLI (adjust names to your actual Hosting sites):
77+
78+
```
79+
firebase target:apply hosting conferencecenterrX dist
80+
firebase target:apply hosting apiopenplannerX api-swagger
81+
firebase target:apply hosting serviceapiX serviceapi-swagger
82+
```
83+
84+
7. Deploy: `firebase deploy`.
85+
86+
8. Run frontend app : `npm run start`. Your app is available on `http://localhost:3000/` .
87+
88+
9. To sign in to the app, create a user in Firebase under Authentication > Users.
6489

6590
### Development
6691

bun.lockb

4.52 KB
Binary file not shown.

firebase.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
},
66
"hosting": [
77
{
8-
"target": "conferencecenterr",
8+
"site": "conferencecenterr2",
99
"public": "dist",
1010
"ignore": ["firebase.json", "**/.*", "**/node_modules/**"],
1111
"rewrites": [
@@ -30,7 +30,7 @@
3030
]
3131
},
3232
{
33-
"target": "apiopenplanner",
33+
"site": "apiopenplanner2",
3434
"public": "api-swagger",
3535
"ignore": ["firebase.json", "**/.*", "**/node_modules/**"],
3636
"rewrites": [
@@ -44,8 +44,8 @@
4444
]
4545
},
4646
{
47-
"target": "serviceapi",
48-
"public": "api-swagger",
47+
"site": "serviceapi2",
48+
"public": "serviceapi-swagger",
4949
"ignore": ["firebase.json", "**/.*", "**/node_modules/**"],
5050
"rewrites": [
5151
{

functions/package-lock.json

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

serviceapi-swagger/.empty

Whitespace-only changes.

0 commit comments

Comments
 (0)