Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ra101 authored Jan 7, 2020
1 parent 9dedecb commit e987e3c
Showing 1 changed file with 23 additions and 18 deletions.
41 changes: 23 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,23 @@
![Made with Electron](https://img.shields.io/badge/Made%20with-Electron-004475?style=for-the-badge&logo=electron) [![Issues](https://img.shields.io/github/issues/ra101/Entry-Management-Software?style=for-the-badge)](https://github.com/ra101/Entry-Management-Software/issues) [![Forks](https://img.shields.io/github/forks/ra101/Entry-Management-Software?style=for-the-badge)](https://github.com/ra101/Entry-Management-Software/network/members) [![Stars](https://img.shields.io/github/stars/ra101/Entry-Management-Software?style=for-the-badge)](https://github.com/ra101/Entry-Management-Software/stargazers) ![Maintained](https://img.shields.io/maintenance/yes/2019?style=for-the-badge&logo=github) ![Open Source](https://img.shields.io/badge/Open%20Source-gray?style=for-the-badge&logo=open-source-initiative) [![Telegram](https://img.shields.io/badge/Telegram-Chat-informational?style=for-the-badge&logo=telegram)](https://telegram.me/ra_101)


# :desktop_computer: Download

[![Release](https://img.shields.io/github/release/ra101/Entry-Management-Software?style=for-the-badge)](https://github.com/ra101/Entry-Management-Software/releases)

To make the above installation working Goto [dotenv](#dotenv)



## :card_index_dividers: Index

- [Index](#card_index_dividers-index)
- [Download](#desktop_computer-download)
- [About](#briefcase-about)
- [Database](#ledger-database)
- [Workflow](#chart_with_upwards_trend-workflow)
- [Usage](#zap-usage)
- [Development](#gear-development)
- [Installation](#floppy_disk-installation)
- [Build](#package-build)
- [File Structure](#open_file_folder-file-structure)
- [Credit/Acknowledgment](#star2-creditacknowledgment)
- [License](#scroll-license)
Expand Down Expand Up @@ -113,11 +119,10 @@ After this Email and a SMS is sent to Visitor, stating the details of zer visit.



## :zap: Usage
## :gear: Development

### :floppy_disk: Installation

:gear: **Development**

If you just want to do a simple test run of the application, you can first

Expand All @@ -139,7 +144,7 @@ $ sudo npm install
- Create an app in Firebase and obtain its Credentials from [Firebase](https://firebase.google.com/)



##### dotenv
- Create a `.env` file in root directory and assign the following environment variables
`NOTE: don't version control your .env file, make sure .env is added in .gitignore file`

Expand All @@ -160,33 +165,33 @@ $ echo "NXSECRET=<Nexmo API Secret>" >> .env
```



- Finally run the application using

```bash
$ node start
```



- Firestore uses gRPC. This works in all types of Electron envs but you may see this error at first: “**Failed to load gRPC binary module because it was not installed for the current system”** . there is devDependencies to resolve that i.e. electron-rebuild, more on that in this [Article](https://medium.com/firebase-developers/using-firebase-in-electron-tips-and-tricks-24ac5b44bf5a).

```bash
$ npm install --save-dev electron-rebuild
```

Then, whenever you install a new npm package, rerun electron-rebuild:
```bash
$ npm run rebuild
```

- Finally run the application using

```bash
$ $(npm bin)/electron-rebuild
$ node start
```

Or if you're on Windows:

```powershell
.\node_modules\.bin\electron-rebuild.cmd
### :package: Build

Install electron-builder as devDep and run dist:
```bash
$ npm install --save-dev electron-builder
$ npm run dist
```

This will Create a "dist" named folder containing unpacked (folder with multiple files) and Installer (executable). These will show an error, as there is no .env file. To resolve this add .env in installed folder (in case of Installer) or .env directly to uppacked folder


## :open_file_folder: File Structure
Expand Down

0 comments on commit e987e3c

Please sign in to comment.