Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

55 lines (33 loc) · 1.95 KB

Contributing to Twester

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Getting started

Before you begin:

Bug report

Please click here and select Bug report option to create a GitHub issue for the bug report.

Feature request

Please click here and select Feature request option to create a GitHub issue for the feature request.

Question

Please click here and select Question option to create a GitHub issue to ask your question. You can also use GitHub Discussions to ask question about Twester or get any help.

Build and run from source

This project was bootstrapped with Electron React Boilerplate (ERB). To understand the project structure and electron specific things, checking out ERB's documentation might be a good place to start.

This is my first electron project and I am sure this boilerplate might have some bloat stuff that Twester doesn't use. Please feel free to make a PR to remove them.

If you have installation or compilation issues with this project, please see ERB's debugging guide.

Clone the repo via git and install dependencies:

git clone https://github.com/twesterapp/twester.git
cd twester
yarn

Starting Development

Start the app in the dev environment:

yarn start

Packaging for Production

To package apps for the local platform:

yarn package