PubLab

Tool that helps you kick off your next web publicaion project in no time.

Content

1. Technologies
2. Prerequisites
3. Setup

Technolgoies

• Electron 10
• Webpack 4
• React 17

Prerequisites

To work on this project you will need to have Git and Node.js installed on the machine.

Setup

From command line:

1. Clone the repository

   # SSH (Recommended if you have keys configured)
   $ git clone git@github.com:vnLab-Lodz/PubLab.git
   
   # HTTPS
   $ git clone https://github.com/vnLab-Lodz/PubLab.git

2. Create an OAuth Application on GitHub

   2a. Enter profile's Settings section

   2b. Select Developer Settings -> OAuth Apps -> New OAuth App

   2c. Pick name for the application (it won't affect the project) and specify Home page URL and Authorization callback URL and register your application

   Home page URL: https://github.com/vnLab-Lodz/PubLab
   
   Authorization callback URL: publab://auth/callback
   

   2d. Inside Client secrets section generate a new client secret

3. Move into directory

   $ cd PubLab

4. Install dependecies

   $ yarn install

5. Create .env file inside the project's root directory

6. Inside the .env file specify client id and secret by pasting the following

   GITHUB_CLIENT_ID=clientid
   GITHUB_CLIENT_SECRET=clientsecret
   

   Where clientid is accessible through created OAuth App under the Client ID section, clientsecret is accessible under the Client secrets section.

7. Run the app in development environment

   $ yarn start

Package manager

Use yarn in this project. If you want to use npm, do so under our own responsibility. (package-json.lock is excluded from repository)