Deploy a Vue.js App with Firebase Hosting - firebase

What is the best Way to deploy a vue.js app initialy created with vue-cli to Firebase Hosting?
I prepared the vue-app for deployment with
npm run build
This creates the folder "dist" with the bundled js-file and assets like pictures.
Then- after installing firebase tools globaly, I run
firebase init
This creates a folder "public" with a default index.html file inside.
First i set in firebase.json:
"hosting": {
"public": "dist"
}
and copied the index.html (the vue index.hltm) from the root-folder to "dist" folder.
Then i deployed with
firebase deploy
It runs, but the paths to the pictures seem to be broken .
I set public folder to "public" in firebase.json
"hosting": {
"public": "public"
}
an put vue index.html there, but then "dist" is not found.
I moved the "dist"-folder inside the "public"folder, and finaly- App is online on firebase.
But now npm run dev is not working any more. Firebase cli seems to break vue-cli.
So how to get vue-cli and firebase-cli playing together?

When you run firebase init few questions will be asked, like which firebase feature you want to use and select your project... when cli asks for
? What do you want to use as your public directory?
Type dist your desired folder. Now the dist folder will be deployed.
Check this link, Hope this helps.

I think i figured it out.
First, keep two separatet Projects, one for vue app and one for Firebase-Hosting.
So the CLI's can work independently and nothing gets broken. Develop your vue.js App and prepare for deploy with npm run build. All you need afterwards is the index.html in vue-project root and the folder dist
Create Firebase project with CLI executing firebase init in empty Folder. Here you can also maintain firebase functions if needed.
You define public directory during firebase init or afterwards editing entry in firebase.json
"hosting": { "public": "public"}
This will become the root-directory of your App. Vue.js expects to have index.html directly in the root-directory and a subfolder dist inside it.
So defining dist as root-directory is not what you want. Related paths like those for pictures in vue-app get broken.
Leave settings for public at default. Then copy index.html and dist-folder from vue-project inside public directory in Firebase-project.
If you want, you can now test localy what will get deployed using firebase serve
If everything fine, deploy using firebase deploy

dist should be your public folder. Here is the working configuration for VueJS with Firebase hosting:
{
"hosting": {
"public": "dist",
"ignore": [
"firebase.json",
"**/.*",
"**/node_modules/**"
],
"rewrites": [
{
"source": "**",
"destination": "/index.html"
}
]
}
}
I've also written a written an in-depth guide on auto-deploying VueJS apps to Firebase hosting

Related

Reactjs & Nodejs App hosting in Firebase issue

I have a simple testing project with NodeJS and ReactJS
.
├── server
└── web
Server - Is for nodejs
Web - Is for Reactjs
I know how to host a single react project.
Is there a way to do that?
Assuming the 'server' is an Express application, you can initialize Cloud Functions in the same directory and use a onRequest() function. You just need to pass the Express app instance in it and you won't have to refactor much of your code. Try running firebase init and initialise Cloud functions and Firebase hosting if you haven't already. If the CLI asks for a directory name for hosting, then enter build (the directory created when you build your React app)
Your directory structure should look something like this now:
app_name/
├─ build/ (React build)
├─ functions/ (created by Firebase CLI for Functions)
│ ├─ index.js
├─ web/ (React app)
Then move the contents of "server" in function and pass the Express app instance in index.js as shown below:
const app = express();
// ... routers
exports.api = functions.https.onRequest(app);
Then make sure all the directory names are updated in firebase.json file. It should look this:
{
"functions": {
"predeploy": "npm --prefix \"$RESOURCE_DIR\" run build",
"source": "functions"
},
"hosting": {
"public": "build",
"ignore": [
"firebase.json",
"**/.*",
"**/node_modules/**"
]
}
}
Now you can deploy both the service by:
firebase deploy --only functions,hosting
You must update the API URL in your web app with the Cloud Function's URL. It should be shown in the CLI once you deploy it.

How to use vue.js and firebase (directory-structure)

When you install firebase, the 'public' folder and 'index.html' are created automatically. I'm not sure where to put the 'public' folder in the current vue project file structure. The 'localhost: 8080' screen is displaying correctly, but the screen using firebase hosting is not showing.
This path is a Vue project. C:\Users\username\public\vue-project
And this path is a Firebase's 'public' folder. C:\Users\username\public
Then I ran 'firebase deploy' in cmd.
cd C:\Users\username>firebase deploy
cd C:\Users\username\public>firebase deploy
If, as you mention in your comments above, you still see the default Firebase "Welcome" page it means that probably you didn't overwrite it correctly.
You should put the entire content of your vue.js dist folder (generated through npm run build) into the public folder of Firebase hosting (and overwrite the default index.html file initially generated by the Firebase project setup script).
Then in you firebase.json file you have the following rewrite in order to handle the Single Page Application behavior of you vue.js application.
{
"hosting": {
"public": "public",
...
],
"rewrites": [
{
"source": "**",
"destination": "/index.html"
}
]
}
}

Firebase deploy is deploying my source folder unencrypted

ISSUE:
My Firebase Deploy is not deploying just the minified file, but also my raw source files and folders.
Details:
I'm using the firebase deploy command, and in my firebase init, I mentioned my folder name(deploy folder name) that's supposed to be deployed.
But when I build my project with npm run build and deploy the project after transferring it to deploy folder, for some reason it also deploys my src folder with all the raw data.
Folder Structure and firebase.json:
Inspecting my hosted site
For some reason, I think I'm doing it wrong , as even my node_modules are being uploaded, I tried to add ./src in ignore
When deploying for Firebase Hosting, you don't specify which folder you want to deploy. firebase.json contains the name of the folder you want to deploy, and almost everything in it is deployed by default. If you want to exclude additional files, you'll have to figure that. Read the documentation for details on how to do that.
The ignore attribute specifies the files to ignore on deploy.
It can take glob pattern the same way that Git handles .gitignore.
The following are the default values for the files to ignore:
"hosting": {
"ignore": [
"firebase.json", // the Firebase configuration file (this file)
"**/.*", // files with a leading period should be hidden from the system
"**/node_modules/**" // contains dependencies used to create your site but not run it
]
}

Firebase hosting not showing up app?

I am new to firebase, and I try to deploy my app to firebase. I have followed all the steps. But, for some reason is not showing up my app. I am getting the welcome modal instead of my web app.
Here are the images:
The step to deploy are as following
STEP 1:
ng build --prod
STEP 2:
firebase init
*Are you ready to proceed?* Yes
*What do you want to use as your public directory?* dist/{your-application-name}
*Configure as a single-page app (rewrite all urls to /index.html)?(y/N)* Yes
*File dist/{your-application-name}/index.html already exists. Overwrite?(y/N)* No
STEP 3:
firebase deploy --only hosting
And if still you are getting the same page just press 'CTRL + F5' it will clean the cached.
It's because the index.html has modified itself when you selected "Y" while initializing the firebase. It has basically replaced your own index file to this one. Check and replace the index file and next time, do not overwrite index.html file. It would work.
I faced the same problem. In my case the issue was not with firebase. Just clearing the cache was the solution.
Firebase hosting not showing up app?
There might be two reasons for this problem
1st step:
Make sure your public folder (define in your firebase.json) 'dist' containing the index.html hasn't been modified by firebase init command, if yes replace it with your original project index.html
for reference (dist is standard but your may different)
{
"hosting": {
"public": "dist"
}
}
2nd step:
Make sure to configure your base href in project's index.html
as
< base href="https://["YOUR FIREBASE PROJECT NAME"].firebaseapp.com/">
and other bundle files as
< script type="text/javascript" src="https://["YOUR FIREBASE PROJECT NAME"].firebaseapp.com/runtime.a66f828dca56eeb90e02.js"></script>
< script type="text/javascript" src="https://["YOUR FIREBASE PROJECT NAME"].firebaseapp.com/polyfills.14fc14f3e029a8cfd046.js"></script>
< script type="text/javascript" src="https://["YOUR FIREBASE PROJECT NAME"].firebaseapp.com/main.2eb2046276073df361f7.js"></script>
3rd step
run the command firebase deploy
enjoy ! ;)
I had ran to this issue and
If anybody had encounters the same after using firebase init command,
check your index.html file in your public folder (for react).
it might have been overridden by firebase.
in order to tell firebase not to override your existing index.html file,
type 'N' when firebase asks if you want to override the existing index.html file
If someone is here because of a
it seems like some domains ending with web.app are blocked from ISP providers, for some countries, I used a private VPN and access my site until it was fixed.
If you're seeing what's in this screenshot, there's another index.html file generated by Firebase, and it points to this one instead of your own. Here's how to fix:
Delete the Firebase-generated index.html and keep your own.
Re-deploy using firebase deploy
For myself, the problem was I given an absolute path to my app location, firebase init seem's only take a relative path.
Since Angular v6 CLI projects are making it easier to have multiple apps with shared codebases. Hence the new folder within dist.
Quoting dotGitignore answer:
I found that the ng build --prod will create a dist and an another
subfolder under this where the project location is.
Check how to fix it here https://stackoverflow.com/a/50360478/11652243
Only solution is firebase deploy file is index.tml but we need build file so replace your
{
"hosting": {
"public": "build",
"ignore": [
"firebase.json",
"**/.*",
"**/node_modules/**"
],
"rewrites": [
{
"source": "**",
"destination": "/index.html"
}
]
}
}
Just replace your firebase.json file with this and you will se the magic
There are a few instances where nothing is really needed. Move all your static files into the public folder you chose. use command
firebase deploy
and just clear the cache by hitting ctrl+f5.
that did it for me.
I faced similar issue when deploying a website in firebase.
Firebase usually creates two default domains, web.app and firebaseapp.com.
If one doesn't work out, use another.
This solved my problem. Try it!
Make sure that you uploading your files to firebase.
Else, use firebase deploy --only hosting to deploy to files from the public directory to firebase.
Follow these steps for the usual deployment. https://alligator.io/angular/deploying-angular-app-to-firebase/
You have to check whether index.html inside the dist folder is regenerated by Firebase.
If so, all you need to do is just delete that html file which is modified by Firebase and create a new index.html file then enforcedly update the content with index.html which is actually created via $ ng build --prod. Now enter $ firebase deploy --only hosting.
So keep an eye of your index.html file contents and its location. if its location is not dist folder. you should give proper location accordingly for public field from firebase.json file.
I have same issue. Follow below steps:
firebase init
*Are you ready to proceed?* Yes
Make a public folder and Copy your all files into it
*What do you want to use as your public directory?*(public) -->only press enter
*Configure as a single-page app (rewrite all urls to /index.html)?(y/N)* N
*File public/index.html already exists. Overwrite?(y/N)* No
Thats it your app will host...
#arslan's answer helped me here & worked for me, went from a blank webpage to being able to see my app.
My solution: I edited my firebase.json file and then npm run build and then re-ran my command firebase emulators:start. Changed the file from
{
"functions": {
"source": "functions"
},
"hosting": {
"public": "public",
"ignore": [
"firebase.json",
"**/.*",
"**/node_modules/**"
],
"rewrites": [
{
"source": "**",
"destination": "/index.html"
}
]
}
}
to...
{
"hosting": {
"public": "build",
"ignore": [
"firebase.json",
"**/.*",
"**/node_modules/**"
],
"rewrites": [
{
"source": "**",
"destination": "/index.html"
}
]
}
}
Figured it out myself, What solved my issue:
ran build (npm run build)
add manually firebase.json and .firebasesrc files to root folder
make sure firebase.json hosting->public is set to "build
run firebase deploy
I had the same issue, I realised for some wierd reason, the firebase.json wasnt in my repo. I created it with config from the above examples, and then I did firebase init again, after it run it found my firebase.json and modified it, it worked
I ran into this same issue and resolved with below steps:
HACK Solution
Step:1 Go to your build folder and replace index.html with your index.html(public folder).
Step:2 Run command: npm run build
Step:3 Select NO => File dist/{your-application-name}/index.html already exists. Overwrite? (y/N) No
Step:4 Then go to the link and press Ctrl+f5. your app will be in front of you. :)
after command firebase init, go to public or dist folder and select all files (not folders) except firebase related files and copy into dist or public folder. After this execute command firebase deploy and wait for a while. After finish go to mentioned url there you will find your working app.
When you ran firebase init Firebase creates a file structure in your project folder and depending on the selections you made it created a /public folder (or another name if you specified) for your public files. Within that /public folder it also creates a index.html file containing the welcome message you are seeing. You need to take your app files (web pages, etc) and move them into that public folder and replace that index.html file along with them. After doing this run the command "firebase deploy" and it will update and you should see your app.
The fix that worked for me was using the second link that firebase provides instead of the first one:
USE: your-project-id.firebaseapp.com (instead of: your-project-id.web.app)
Before deploying ensure your files are in the newly created directory e.g y or public folders
in my case after building with ng build i told firebase the source directory is dist, but actually it was dist/my-project...
(there was a firebase index.html in dist. angular index.html was in dist/my-project...)
Sometimes when this happen you need to logout firebase logout on your CLI,
then login again firebase login.
Then repeat all the procedures for hosting
And make sure you initialized Firebase Firebase.initializeApp() on your main method if you are using flutter.
This worked for me.
During initialization of the firebase directory you need to choose build as public directory.
The run
1.npm run build
2.firbase deploy
If this doesn't work try clearing the cache of your browser.
Here I found an answer to the question
Step1: Initialize the firebase first.
$firebase init
Step2: Create a production build now.
$ng build --prod
Step:3 It's time to deploy your app.
$firebase deploy

How do I switch apps from the firebase cli?

This seems like something which should be pretty easy to do, but for whatever reason, I'm being defeated.
I'm trying to use the firebase-tools CLI to interact with my database. I'm able to login without any trouble, and when I type firebase list, I get a list of all my current apps. It also tells me which app I'm currently connected to.
My problem is, I want to connect to one of the other apps. I'm running queries on my staging app, and I need to run them on my production app. I can see the production app in the list, but I'm not finding any way to switch to that app.
Thoughts?
Found some useful information here Firebase CLI Reference.
The following code works for me.
firebase use <project_id>
I rather use scripts. Consider a project structure like this:
your-project
├── .firebaserc
└── functions
├── package.json
└── index.js
Go to .firebaserc and follow the next example
{
"projects": {
"default": "project-name",
"prod": "other-name"
}
}
Then go to package.json and add the following scripts (changeToProd, and changeToDev).
{
...
"scripts": {
...
"changeToProd": "firebase use prod",
"changeToDev": "firebase use default"
},
"dependencies": {
...
},
...
}
If your IDE support npm scripts you can run them using the IDE UI, otherwise it can be run using the command console. Make sure you are inside the functions folder.
npm run-script changeToProd
You can verify your current project by running the following command from the terminal or added to the scripts as we just did
firebase use
If you are using Node.js on windows, your answer should be
firebase use <project_id>
but without the <> for example
firebase use chat-app-2a150
You can use the following code to view all your projects so as to pick the correct project ID to use
firebase projects:list
2020:
The officially recommended way is to use "alias":
In your .firebaserc, set different project IDs like this:
{
"projects": {
"production": "my-project-id",
"testing": "my-testing-project-id"
}
}
// you can also add them interactively with `firebase use --add`
Then switch projects in CLI with firebase use testing , firebase use production.
Note: switching projects won't create any git diff, it's simply remembered in your local machine. Use firebase use to see which project is currently being used.
Uncommon cases:
If you want to use your own ID without committing changes to the project owner's .firebaserc, do firebase use my-own-id locally as mentioned in the accepted answer.
If you want people to fork your code then use their own IDs, add .firebaserc into .gitignore.
In the directory where you run firebase list, there will be a file called firebase.json. If you open that in a text editor, you will see the app name in there. You can change it there or delete firebase.json to change the app.
Or save yourself the hassle of editing a text file and do as Jason says: use firebase init.
you can just use a command line switch
--project=my-firebase-project
I may be wrong but it seems that the original question was about changing apps within a given project, rather than simply changing projects.
This answer is about changing apps and site_IDs within a project.
In my case I have a project (CoolProject) with 2 web apps:
an assessment form: form
a main website: website
Both apps are in separate repos both locally and in GitHub.
Each app has its own specific site_ID:
form: coolproject-form[.web.app]
website: coolproject-website[.web.app]
I first setup the form app and deployed without any issue to coolproject-form. But when I created the web app (and associated coolproject-website site_ID) and tried to deploy it using firebase deploy --only hosting or firebase deploy --only hosting:website it incorrectly deployed it to coolproject-form overwriting the form app.
This is how I eventually solved the issue (based on this Firebase documentation):
Check that both apps and corresponding site_IDs are correctly setup:
firebase apps:list
firebase hosting:sites:list
Setup up the website deploy target for hosting (via .firebaserc)
firebase target:apply hosting website coolproject-website
Update firebase.json (for the website app):
...
"hosting": [{
"target": "website",
"public": "build",
"ignore": [
"firebase.json",
"**/.*",
"**/node_modules/**"
],
"rewrites": [
{
"source": "**",
"destination": "/index.html"
}
]
}],
...
Deploy
firebase deploy --only hosting
With this the website app is now correctly deployed to coolproject-website.web.app.
Addition #cutiko's answer
In package.json
"scripts": {
...
"prod": "echo \"Switch to Production environment\" && firebase use prod && npm run runtimeconfig",
"dev": "echo \"Switch to Development environment\" && firebase use default && npm run runtimeconfig"
...
npm run runtimeconfig to get custom config environment
In .firebaserc
{
"projects": {
"default":"{project-dev-id}",
"prod": "{project-prod-id}"
}
}
to change firebase app destination project you can type "firebase use myProjectName" . i also used the above answeres "firebase list" to check what project i have
( work for me in firebase cli 7.4 with angular 7 app)

Resources