Skip to content

Commit 0d41165

Browse files
authored
Update README.md
1 parent 964f31f commit 0d41165

File tree

1 file changed

+57
-1
lines changed

1 file changed

+57
-1
lines changed

README.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,57 @@
1-
# Blogosaurus
1+
# Blogosaurus ![GitHub deployments](https://img.shields.io/github/deployments/binaryshrey/blogosaurus/production?style=flat&logo=vercel&label=vercel)
2+
3+
Publish blogs at the speed of light : Instantly share your thoughts with our blazing-fast blogging platform - [View](https://blogosaurus.vercel.app/)
4+
5+
![Banner](https://raw.githubusercontent.com/binaryshrey/Blogosaurus/main/blogo-product.png)
6+
7+
### Development setup
8+
9+
```
10+
git clone https://github.com/binaryshrey/Blogosaurus.git
11+
cd Blogosaurus
12+
npm i
13+
npm run start
14+
```
15+
16+
#### Firebase configs
17+
- Create a .env file for Firebase
18+
```
19+
REACT_APP_FIREBASE_API_KEY=**********
20+
REACT_APP_FIREBASE_AUTHDOMAIN=**********.firebaseapp.com
21+
REACT_APP_FIREBASE_PROJECTID=**********
22+
REACT_APP_FIREBASE_STORAGE_BUCKET=**********.appspot.com
23+
REACT_APP_FIREBASE_MESSAGESENDER_ID=**********
24+
REACT_APP_FIREBASE_APPID=**********
25+
REACT_APP_FIREBASE_MEASUREMENTID=**********
26+
```
27+
28+
- Include Google & Github Auth under Firebase Authentication
29+
- Include Firebase-Firestore with below prod db-rule:
30+
```
31+
rules_version = '2';
32+
service cloud.firestore {
33+
match /databases/{database}/documents {
34+
match /users/{uid} {
35+
allow create: if request.auth != null;
36+
allow read;
37+
allow update, delete: if request.auth != null && request.auth.uid == uid;
38+
39+
}
40+
match /blogs/{uid} {
41+
allow create: if request.auth != null;
42+
allow read : if request.auth != null;
43+
allow update, delete: if request.auth != null && request.auth.uid == uid;
44+
45+
}
46+
}
47+
}
48+
```
49+
50+
51+
Development server runs at `http://localhost:3000`
52+
53+
54+
55+
56+
57+

0 commit comments

Comments
 (0)