hackclub / shipit-legacy

DEPRECATED: Utility for adding projects to https://shipped.hackclub.com

Ship It

DEPRECATED

This repository has been deprecated and is no longer maintained.

---

Ship It is a utility for generating pull requests to submit projects to https://shipped.hackclub.io.

Getting Started

Requirements

• Node

After cloning the repo, install all dependencies:

$ npm install

Create a file called .env and put the following in it (replace TODO with real values):

SESSION_SECRET=TODO
GITHUB_CLIENT_ID=TODO
GITHUB_CLIENT_SECRET=TODO
GITHUB_CALLBACK_URL=TODO

• Session Secret: secret used to encrypt the session
• GitHub Client ID: client id for the application on GitHub
• GitHub Client Secret: client secret for the application on GitHub
• GitHub Callback URL: callback url for the application on GitHub

Start the server:

$ npm start

License

This repository is distributed under the MIT license found in the LICENSE file.