clsoar / front-end

Operation Code's website

See unblocked, unassigned issues.

Welcome!

This is incoming v2 front-end application for OperationCode. We highly recommend joining our organization to receive an invite to our Slack team. From there, you'll want to join the #oc-projects channel. You can get help from multiple professional developers, including people who have worked on the application since day 1! Our website is currently served by code located here, but that repository is no longer being developed.

Before contributing, please review our Contributing Guide

Maintainers

For information about the maintainers of the project, check out MAINTAINERS.md.

Quick Start

If you're unsure of how to start this app or code for it, don't worry! You're our target audience! Please read our Contributing Guide to learn everything you need to be able to ask the right questions on our Slack team.

In continuing with the quick start instructions, it is assumed that you are no stranger to React applications, the JavaScript ecosystem, and standard GitHub workflows such as forking, cloning, and branching.

Our entire UI library is documented via

Recommended versions of tools used within the repo:

• Node: See .nvmrc
• [email protected] or greater
• [email protected] or greater

# Install dependencies
yarn

# Run local development
yarn dev

# Use Storybook as a workbench when developing new components
yarn storybook

# Run all unit tests
yarn test

# Run all Cypress tests (make sure your dev server is running)
yarn test:e2e

# Create all the necessary files/folders for a new, reusable component
yarn create-component $ComponentName

# Create the necessary file with a small boilerplate for a new page
yarn create-page $PageName