Skip to content

Fix installation documentation and configuration#220

Open
isalyne34 wants to merge 2 commits intoHugoGresse:mainfrom
isalyne34:UpdateReadme
Open

Fix installation documentation and configuration#220
isalyne34 wants to merge 2 commits intoHugoGresse:mainfrom
isalyne34:UpdateReadme

Conversation

@isalyne34
Copy link

Summary
Improves the installation process to make first-time setup smoother by clarifying steps and fixing configuration issues.

Changes
README updates:

  • Restructure installation steps with clearer instructions
  • Add explicit Firebase project requirements (Blaze plan, Node 20+)
  • Detail web app creation for API, ConferenceCenter, and ServiceApi hosting sites
  • Add step-by-step Firebase CLI configuration
  • Clarify frontend launch command and specify port (http://localhost:3000/)
  • Add instruction to create initial Firebase user for authentication

Configuration fixes:

  • Update firebase.json to use site instead of target for hosting deployment
  • Fix ServiceApi public folder path from api-swagger to serviceapi-swagger
  • Create .empty file in serviceapi-swagger to ensure directory exists

fix: update readme

fix : readme
@isalyne34 isalyne34 marked this pull request as ready for review January 26, 2026 17:44
Copilot AI review requested due to automatic review settings January 26, 2026 17:44
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Improves first-time setup by updating installation documentation and adjusting Firebase Hosting configuration for multi-site deployments and ServiceApi swagger hosting.

Changes:

  • Restructures README.md setup steps (Firebase requirements, CLI workflow, local run instructions).
  • Updates firebase.json hosting entries (switch to site and correct ServiceApi public directory).
  • Adds serviceapi-swagger/.empty to ensure the swagger directory exists in the repo.

Reviewed changes

Copilot reviewed 2 out of 5 changed files in this pull request and generated 9 comments.

File Description
serviceapi-swagger/.empty Ensures serviceapi-swagger directory is present for hosting/public path.
functions/package-lock.json Adds license metadata for a couple of dependencies in the lockfile.
firebase.json Updates hosting configuration (site ids + ServiceApi swagger public dir).
README.md Updates installation/setup instructions for Firebase, hosting, and local dev.
Files not reviewed (1)
  • functions/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

firebase.json Outdated
Comment on lines 8 to 10
"site": "conferencecenterr2",
"public": "dist",
"ignore": ["firebase.json", "**/.*", "**/node_modules/**"],
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The hosting config hard-codes a specific Hosting site id ("conferencecenterr2"). Since .firebaserc is gitignored and the repo includes .firebaserc.example targets, committing environment-specific site ids will likely break deploys for other developers/projects. Consider reverting this entry back to using target and rely on firebase target:apply, or make the committed value a generic/default site id that matches the documented setup.

Copilot uses AI. Check for mistakes.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm interessant !
je pense aussi qu'il faut que on trouve une autre solution

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

J'ai mis a jour le .firebaserc.example et modifié le firebase.json afin que ce dernier prenne en compte les valeurs présentes dans .firebasrc, les valeurs ne sont ainsi plus hard-codées dans le firebase.json

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 6 changed files in this pull request and generated 2 comments.

Files not reviewed (1)
  • functions/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 6 changed files in this pull request and generated 2 comments.

Files not reviewed (1)
  • functions/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

fix readme

fix readme
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 6 changed files in this pull request and generated 3 comments.

Files not reviewed (1)
  • functions/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 2 to 7
"projects": {
"default": "conferencecenterr"
"default": "openplanner"
},
"targets": {
"conferencecenterr": {
"openplanner": {
"hosting": {
Copy link

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In .firebaserc, projects.default is expected to be a Firebase project ID or a locally-defined alias. Using openplanner as the example value can be confused with the Web App name from the README. Consider changing this to an explicit placeholder like your-firebase-project-id (and similarly for the targets top-level key) to reduce setup mistakes.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants