Skip to content

Commit

Permalink
Merge pull request #9 from AayushK47/dev
Browse files Browse the repository at this point in the history
Added direct connection to db after first usage
  • Loading branch information
AayushK47 authored May 2, 2021
2 parents 1e76595 + db0a086 commit e77c28f
Show file tree
Hide file tree
Showing 6 changed files with 9,131 additions and 55 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ node_modules/
coverage/
dist/
config.json
fb.json
.env
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Changelog

All notable changes will be documented i this file

## Changelog v1.1.0

### Added

- Setup for a config file which can be used to access the database directly without answering the prompts everytime user starts the shell.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ Fireshell is a CLI tool which can be used to execute realtime database and cloud
![GitHub package.json version](https://img.shields.io/github/package-json/v/AayushK47/fireshell?style=for-the-badge)
![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/AayushK47/fireshell?color=yellowgreen&style=for-the-badge)

## Changelog v1.1.0

### Release Highlights

Added a setup for a config file which can be used to access the database directly without answering the prompts everytime user starts the shell.


## Installation
Expand All @@ -35,12 +40,16 @@ First you'll have to choose the service you want to connect with :-

Then you have to provide the **absolute path** to your firebase config file. It has to be a JSON file that you get from firebase to connect your application with your firebase project.

**Important Note:-** Please make sure that the firebase config file has a key called "projectId". This key is very important in order to authenticate. If your config file has a key called "project_id", rename it to "projectId".

<img width="500" alt="Portfolio" src="./media/m2.png">

The last prompt will ask you to enter the reltime database url. If you chose firestore in the 1st prompt, then your can ignore this question. Otherwise, enter the url.

<img width="500" alt="Portfolio" src="./media/m3.png">

**Note:-** In versions >= 1.1.0 these prompts will be asked only once. After that, the shell will connect automatically using previously provided parameters.

### Writing Queries

Your queries must start with the keyword `db`. This `db` is a variable that stores reference to the database object. You can chain the rest of your query as you normally do.
Expand Down
Loading

0 comments on commit e77c28f

Please sign in to comment.