Tool that helps you kick off your next web publicaion project in no time.
- Electron 10
- Webpack 4
- React 17
To work on this project you will need to have Git and Node.js installed on the machine.
From command line:
-
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
-
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
-
Move into directory
$ cd PubLab
-
Install dependecies
$ yarn install
-
Create .env file inside the project's root directory
-
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. -
Run the app in development environment
$ yarn start
Use yarn in this project. If you want to use npm, do so under our own responsibility. (package-json.lock
is excluded from repository)