README - Peach QE

- Initial Commit -
(Minimum set of features, including DevTools toggling in DEV mode)

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
3. Deployment
4. License
5. Contact
6. Acknowledgements

About The Project

Our first hands on attempt to understand Relay.

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Electron

Getting Started

• Fork and Clone the Repo:

  git clone https://github.com/oslabs-beta/peach.git

Prerequisites

Install the dpendencies:

• [ npm i ]

  npm install

• Run the Electron App locally

  npm start

Deployment

1. In order to build the executable file (aka, the desktop client) you will need to run specific commands for your OS:

• Mac:

  npm run package-mac

• Windows:

  npm run package-win

• Linux:

  npm run package-linux

2. Look for the directory Release-builds in the root folder where you cloned this Repo. (created automatically by the previous command)

3. Find the specific folder for your OS. (e.g., peachQE-win)

4. The file peachQE.exe (in Windows) will launch the app in your machine.

Enjoy!

For more examples, please refer to the Documentation

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements to the PEach QE team:

• Alura Chung-Mehdi
• Roland Wynter
• Graham Albachten
• Nakami Hope-Felix
• Carlos Botero-Vargas

---

THANK YOU!