Skip to content

TeamHarrington/code-reviewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

edeb47c · Jul 22, 2020

History

59 Commits
Feb 24, 2020
Oct 13, 2019
Feb 24, 2020
Dec 2, 2019
Jul 22, 2020
Feb 26, 2020
Oct 13, 2019
Feb 14, 2020
Jun 9, 2020
Oct 13, 2019
Oct 13, 2019
Oct 13, 2019
Oct 22, 2019
May 22, 2020
Feb 14, 2020
Feb 14, 2020
Feb 24, 2020
Nov 22, 2019
Oct 13, 2019
Feb 14, 2020
Jul 22, 2020
Feb 14, 2020
Jul 22, 2020

Repository files navigation

code-reviewer

dependencies Status devDependencies Status

  • @code-reviewer/api dependencies Status devDependencies Status
  • @code-reviewer/client dependencies Status devDependencies Status

Anonymous online peer code review made easy.

Requirements

Getting Started (first time)

yarn        # Run in project root to install all node dependencies

Starting Application

yarn start  # Run in project root to start code reviewer app

This will deploy the @code-reviewer/api server and have it also serve @code-reviewer/client. Navigate to http://localhost:3000 for the webpage and http://localhost:3000/graphql for the GraphQL playground.

Starting in development mode

@code-reviewer/api

yarn dev:api

Starts @code-reviewer/api standalone (without @code-reviewer/client) in development mode with nodemon.

@code-reviewer/client

yarn dev:client

Starts @code-reviewer/client standalone (without @code-reviewer/api) in development mode with nodemon.

Building client

yarn build:client

Open storybook for client

yarn storybook

Download GraphQL Schemas

yarn schema:download

Please refer here for more information

Generate Client GraphQL types

yarn codegen:generate

Please refer here for more information

Linting Code

yarn lint

This will lint all .ts and .tsx files in the codebase. We may add linting for .js & .jsx files later if necessary.

Testing Code

yarn test

Runs all the test files in all the sub-repositories.

Code Structure

All the project is written in Typescript. However, some build tasks, such as gulpfile.js, will be written in Javscript.

code-reviewer/
├─ packages        # Contains all repos for this monorepo
  ├─ api           # Backend API
  ├─ client        # Frontend Application
├─ docs            # General documentation
├─ tools           # General tools used by main application
  ├─ gulp-tasks    # List all tasks related to gulpfile.js

Contact Us

Please send emails to code.reviewer.utsc@gmail.com