Skip to content

Commit c7a80a0

Browse files
committed
update to readme
1 parent 9f62fa7 commit c7a80a0

File tree

2 files changed

+18
-21
lines changed

2 files changed

+18
-21
lines changed

README.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,11 @@ Note: The local api gets discarded on deploying to Firebase. So, It's vuejs talk
3636

3737
Key software versions. Node: 10.0.0 and NPM: 6.0.0
3838

39-
#### Running the API component: http://localhost:1234/
39+
#### Running the API component (Local): http://localhost:1234/
40+
41+
At this point we're directly talking to firebase and not making progress on the local API component. Eventually, we'll support AWS Lambda, Azure Cloud Functions etc. and add support for building locally and deploying on a set of faas/serverless platforms.
42+
43+
Skip following steps for now:
4044

4145
```
4246
$ git clone https://github.com/Rajan/lesspod.git //clone repo
@@ -56,36 +60,29 @@ $ npm install
5660
$ npm run dev
5761
```
5862

59-
Keep things as simple to understand for others as possible. Also, add comments to any code being contributed.
63+
To deploy Vuejs client to Firebase
6064

61-
Feel free to create an issue if you face problems. Kindly include your package.json, OS and browser details.
65+
1. Create a Firebase project and enable email auth, create firestore db, enable storage etc.
66+
2. Execute npm init with all options ON.
67+
3. Add firebase properties in the /client/vue/src/config.js
68+
4. Install all npm packages.
69+
5. Run "npm run build" and "firebase deploy".
6270

6371

64-
## Deploying to Firebase (WIP)
72+
We're also implementing Nuxt.js (WIP).
6573

66-
Create a firebase_init.txt file in the root with web script tags from your Firebase project.
67-
We've created two utilities for firebase deploy and rollback. fbase_prep.js will inject firebase calls.
68-
69-
```
70-
node fbase_prep.js // create new git branch and inject firebase scripts
71-
node fbase_cleanup.js // rollback changes and move back to master branch
74+
Note: Vuejs client is a bit behind the reactjs client and we're looking for contributors who can support the development of vuejs client.
7275

73-
```
7476

77+
Feel free to create an issue. Kindly include your package.json, OS and browser details.
7578

76-
<!--
7779

78-
#### Running the React client in another commandline window: http://localhost:3000
80+
## Deploying React client to Firebase
7981

80-
```
81-
$ cd client/react
82-
$ npm install
83-
$ npm start
84-
```
85-
Note: React client is at a very early stage in the development.
82+
Check out README inside /client/react for instructions.
8683

87-
-->
8884

85+
Keep things as simple to understand for others as possible. Also, add comments to any code being contributed.
8986

9087
## To Do List
9188

client/react/src/screens/LandingScreen.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class LandingScreen extends React.Component {
3232
} = settingsStore.landingPage;
3333
return (
3434
<div style={{ backgroundColor: '#FFF' }}>
35-
<YoutubeVideo />
35+
{ /* <YoutubeVideo /> */}
3636
{ /*<MyGallery />*/}
3737
<section className="section">
3838
<div className="hero-body">

0 commit comments

Comments
 (0)