Files
rowy/README.md

73 lines
1.3 KiB
Markdown
Raw Normal View History

2019-09-06 09:53:56 +10:00
## Firetable
2019-11-13 14:51:08 +11:00
Firetable is an Excel/Google Sheets like UI for Firebase/Firestore. No more building admin portal for allowing business users to access data from GCP.
2019-09-06 09:53:56 +10:00
2019-09-26 16:31:33 +10:00
## Setup instructions
2019-09-06 09:37:30 +10:00
2019-11-13 14:52:06 +11:00
#### 1) Create a firebase project ([instructions](https://console.firebase.google.com/u/0/))
2019-10-16 11:36:20 +11:00
- enable firestore
2019-10-22 16:55:46 +11:00
- setup security rules: test mode or setup required permission
- upgrade project to Blaze plan
- go to authentication/ sign method enable google auth
2019-10-16 11:36:20 +11:00
2019-10-02 11:13:45 +10:00
#### 2) Create an algolia project
2019-10-16 11:36:20 +11:00
2019-10-16 12:14:30 +11:00
- get the generated appId,API key and search key
2019-10-16 11:39:16 +11:00
2019-10-16 11:36:20 +11:00
#### 3) Clone repo
```
git clone https://github.com/AntlerVC/firetable.git
```
#### 4) Setup cloud functions
2019-10-22 16:55:46 +11:00
install dependencies
```
cd cloud_functions/functions;yarn
```
insure that you have firebase cli installed, [instructions](https://firebase.google.com/docs/cli)
then set cloud environment keys using the following commands
2019-09-27 08:04:25 +10:00
```
2019-10-01 16:55:22 +10:00
firebase functions:config:set algolia.appid=YOUR_APP_ID algolia.apikey=ADMIN_API_KEY
2019-09-27 08:04:25 +10:00
```
2019-10-16 11:36:20 +11:00
Deploy the cloud functions to your firebase project
2019-09-27 08:04:25 +10:00
```
2019-10-22 16:55:46 +11:00
yarn deploy
2019-09-27 08:04:25 +10:00
```
2019-10-02 11:13:45 +10:00
#### 5) Set environment variables
2019-09-06 09:37:30 +10:00
2019-10-23 12:37:50 +11:00
2019-10-22 12:52:00 +11:00
create a .env file in the www directory
2019-09-06 09:37:30 +10:00
2019-09-26 18:21:22 +10:00
```
2019-09-26 16:31:33 +10:00
REACT_APP_FIREBASE_PROJECT_NAME =
REACT_APP_FIREBASE_PROJECT_KEY =
REACT_APP_ALGOLIA_APP_ID =
REACT_APP_ALGOLIA_SEARCH_KEY =
2019-09-26 18:21:22 +10:00
```
2019-09-06 09:37:30 +10:00
2019-10-22 16:55:46 +11:00
#### 6) Run frontend
install dependencies
2019-09-27 08:04:25 +10:00
```
2019-10-16 12:14:30 +11:00
cd www;yarn
2019-09-27 08:04:25 +10:00
```
2019-10-02 11:13:45 +10:00
#### 7) Run project locally
2019-09-06 09:37:30 +10:00
2019-09-27 08:04:25 +10:00
```
2019-09-26 16:31:33 +10:00
yarn start
2019-09-27 08:04:25 +10:00
```