Skip to content

Commit 7d86c46

Browse files
committed
update README
1 parent 4bd65ad commit 7d86c46

File tree

1 file changed

+59
-2
lines changed

1 file changed

+59
-2
lines changed

README.md

Lines changed: 59 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
> NOTE: This repository contains the new roadmap-dev of Myfirebase, if you want to build an application with myfirebase please visit the main [Repository](https://github.com/myfirebase/myfirebase).
2-
31
<p align="center">
42
<img src = "http://i.imgur.com/eui4MCQ.png">
53
</p>
@@ -16,4 +14,63 @@
1614

1715
> Currently, Myfirebase is in development stage, feel free to participate.
1816
17+
## Docs
18+
19+
[Documentation](https://myfirebase.github.io).
20+
21+
## Prerequisites
22+
23+
1. **NPM** is the recommended installation method when building large scale applications with **Myfirebase**.
24+
25+
- [How to Install Node.js and NPM on Windows](http://blog.teamtreehouse.com/install-node-js-npm-windows)
26+
27+
- [How to Install Node.js and NPM on a Mac](http://blog.teamtreehouse.com/install-node-js-npm-mac)
28+
29+
- [How to Install Node.js and NPM on a Linux](http://blog.teamtreehouse.com/install-node-js-npm-linux)
30+
31+
2. **Firebase command line interface**, `npm install -g firebase-tools`
32+
33+
3. **Myfirebase command line interface**, `npm install -g myfirebase-cli`
34+
35+
## Installation
36+
37+
```shell
38+
# Create new project with myfirebase-cli
39+
$ myfirebase new:project my-project
40+
41+
# Change directory
42+
$ cd my-project
43+
44+
# Install dependencies
45+
$ npm install
46+
47+
# Sign in using your Google account
48+
$ firebase login
49+
50+
# Initialize firebase project
51+
$ firebase init
52+
```
53+
54+
### Run dev server
55+
56+
```shell
57+
# Run the server
58+
$ npm run dev
59+
```
60+
61+
### Production
62+
63+
64+
```shell
65+
# Production
66+
$ npm run build
67+
```
68+
69+
### Deploy your project
70+
71+
```shell
72+
# Deploy project
73+
$ firebase deploy
74+
```
1975

76+
### Contact : amranidev@gmail.com

0 commit comments

Comments
 (0)