maferland / seshat

✏️ The all-in-one Github's issues aggregator (technical test 2018)

Note: This was an hiring test.

Seshat

Seshat is an easy-to-use yet powerful Github issues aggregator.

Table of content

• Improvements
• Design decisions
• Onboarding

Getting started

Prerequisites

• nodejs
• yarn (or npm)

Installing

Getting the code

git clone [e-mail]:fizzerpostcards/marc-antoine-technical-test.git
cd marc-antoine-technical-test/

With NPM

npm install
npm run dev

With Yarn

yarn
yarn run dev

Commands

The various command you will need to run the project.

• Build -> yarn run build
• Deploy -> yarn run deploy
• Run -> yarn run develop
• Lint -> yarn run lint

Deployment

Seshat is built on firebase. You can create your own firebase project and edit helpers/firebaseConfig.js if you want to deploy it by yourself.

To do so, you will be required to install firebase tools.

npm install -g firebase-tools
firebase login

Then, you will be able to deploy it 🚀

With NPM

npm run deploy

With Yarn

yarn run deploy