mirror of
https://github.com/rowyio/rowy.git
synced 2025-12-29 00:16:39 +01:00
update set up instructions
This commit is contained in:
53
README.md
53
README.md
@@ -7,7 +7,7 @@ Cloud.
|
||||
|
||||

|
||||
|
||||
[](https://discord.gg/Vdshr9E)
|
||||
<!-- [](https://discord.gg/Vdshr9E) -->
|
||||
|
||||
### Firetable UI
|
||||
|
||||
@@ -19,8 +19,10 @@ supported. More coming soon, for comprehensive list see ROADMAP.md.
|
||||
|
||||
## Setup instructions
|
||||
|
||||
### 1. Create a Firebase project [(Instructions)](https://console.firebase.google.com/u/0/)
|
||||
### 1. Create and set up a Firebase project
|
||||
|
||||
- Create a new project using the
|
||||
[Firebase Console](https://console.firebase.google.com/)
|
||||
- Create a Firestore database
|
||||
- Set up Firestore Security Rules: use Test Mode or set up required permissions.
|
||||
|
||||
@@ -38,18 +40,53 @@ supported. More coming soon, for comprehensive list see ROADMAP.md.
|
||||
}
|
||||
```
|
||||
|
||||
[Or follow this guide for setting up you rules](RULES.md)
|
||||
[Or follow this guide for setting up custom rules](RULES.md)
|
||||
|
||||
- Upgrade project to the Blaze Plan
|
||||
- Enable the Google sign-in method in **Authentication / Sign-in method**
|
||||
|
||||
### 2. Clone this repo
|
||||
### 2. Run the Firetable CLI
|
||||
|
||||
The Firetable CLI automates the steps required to set up your Firetable app
|
||||
locally.
|
||||
|
||||
Before using it, make sure you have the Firebase CLI installed.
|
||||
[Instructions](https://firebase.google.com/docs/cli)
|
||||
|
||||
```
|
||||
npm install -g firetable
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
yarn global add firetable
|
||||
```
|
||||
|
||||
Then run the following command, specifying the directory for your Firetable app.
|
||||
|
||||
```
|
||||
firetable init [directory]
|
||||
```
|
||||
|
||||
Now you can run Firetable locally using
|
||||
|
||||
```
|
||||
cd [directory]
|
||||
firetable start
|
||||
```
|
||||
|
||||
### 3. Manually set up Firetable app
|
||||
|
||||
If you don’t want to run the Firetable CLI, follow these steps:
|
||||
|
||||
#### 1. Clone this repo
|
||||
|
||||
```
|
||||
git clone https://github.com/AntlerVC/firetable.git
|
||||
```
|
||||
|
||||
### 3. Set React app environment variables
|
||||
#### 2. Set React app environment variables
|
||||
|
||||
Create a .env file in the `www` directory
|
||||
|
||||
@@ -57,7 +94,7 @@ Create a .env file in the `www` directory
|
||||
Project’s **Settings** page. Click the cog icon on the left sidebar (under the
|
||||
Firebase logo) and click **Project settings**
|
||||
|
||||
- (optional) Get the generated **Application ID** and **Search-Only API Key**
|
||||
- (Optional) Get the generated **Application ID** and **Search-Only API Key**
|
||||
from the Algolia **API Keys** page
|
||||
|
||||
```
|
||||
@@ -67,14 +104,14 @@ REACT_APP_ALGOLIA_APP_ID=
|
||||
REACT_APP_ALGOLIA_SEARCH_API_KEY=
|
||||
```
|
||||
|
||||
### 4. Install front-end dependencies
|
||||
#### 3. Install front-end dependencies
|
||||
|
||||
```
|
||||
cd www
|
||||
yarn
|
||||
```
|
||||
|
||||
### 5. Run project locally
|
||||
#### 4. Run project locally
|
||||
|
||||
```
|
||||
yarn start
|
||||
|
||||
@@ -1,42 +1,48 @@
|
||||
# Firetable CLI
|
||||
|
||||
## Prerequisites
|
||||
## Installation requirements
|
||||
|
||||
please insure you have the following installed;
|
||||
[Git](https://git-scm.com/downloads), [Node](https://nodejs.org/en/download/),
|
||||
[Yarn](https://classic.yarnpkg.com/en/docs/install/)
|
||||
Make sure you have the following installed:
|
||||
|
||||
### Firebase
|
||||
- [Git](https://git-scm.com/downloads)
|
||||
- [Node](https://nodejs.org/en/download/)
|
||||
- [Firebase CLI](https://firebase.google.com/docs/cli)
|
||||
|
||||
insure that you have [firebase-tools](https://firebase.google.com/docs/cli) and
|
||||
logged in to your firebase account.
|
||||
Also make sure you are logged in to your Firebase account in the Firebase CLI.
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
npm install -g firetable@latest
|
||||
npm install -g firetable
|
||||
```
|
||||
|
||||
## Setup
|
||||
|
||||
set directory you want to setup firetable in then run
|
||||
or
|
||||
|
||||
```
|
||||
firetable init
|
||||
yarn global add firetable
|
||||
```
|
||||
|
||||
### run Locally
|
||||
## Commands
|
||||
|
||||
### Create a new project
|
||||
|
||||
```
|
||||
firetable init [directory]
|
||||
```
|
||||
|
||||
### Run firetable locally
|
||||
|
||||
Before you run locally, make sure you have a Firebase project set up.
|
||||
[Instructions](https://github.com/AntlerVC/firetable#setup-instructions)
|
||||
|
||||
```
|
||||
firetable start
|
||||
```
|
||||
|
||||
### deploying to firebase hosting
|
||||
### Deploy to Firebase Hosting
|
||||
|
||||
insure that you have created a site on your projects
|
||||
[firebase hosting](https://console.firebase.google.com/u/0/project/_/hosting)
|
||||
|
||||
then run
|
||||
First, make sure that you have created a site in your Firebase project.
|
||||
[Open Firebase console](https://console.firebase.google.com/)
|
||||
|
||||
```
|
||||
firetable deploy
|
||||
|
||||
Reference in New Issue
Block a user