For folks working on this code base, we're organizing coding style and general guidelines here.

TC Deployment Notes

[TC Deployment Notes should always be kept up to date on the default branch. Update these notes when changes to this information occur]

General Deployment: This software is deployed to AWS S3 by CircleCI. It's ultimately delivered through AWS Cloudfront, which is fed from the S3 bucket. There are no EC2 systems involved in the delivery (althought Connect is fed from various micro-services).

Branches:

• Any commits to dev will will trigger a build and deploy to the dev AWS environment
• Any commits to feature/deep-links will will trigger a build and deploy to the dev AWS environment
• Any commits to master will trigger a build and deploy to the prod AWS environment

Development Flow: This repo uses typical Gitflow (feature/[feature name], hotfix/[fix name], ...etc). Generally changes to prod should be merged from dev to master. Hotfixes should be merged to master and dev at the same time.

Additional Notes:

• The circle.yml file controls the build - see this file if you need to confirm if your commit will deploy anything
• Circle-ci builds can be easily cancelled - please do so if you accidentally trigger an undesired build

Customer-App

This repository houses new Customer pages, using React, Redux, and Webpack.

Installation

We use node 8.9.x and npm 6.x, so you may need to download a new version of node. The easiest way is to download nvm. We have a .nvmrc file in the root of the project, so you can just run nvm use to switch to the correct version of node.

Install dependencies by running the following in the root of the project:

• npm i
• Note: You must use npm 6.x. Type npm -v to ensure you have the correct version.

NPM Commands

• To run locally, run npm start and head to http://localhost:3000/new_project
• Run tests with npm test or use npm run test:watch to rerun tests after files change
• To make sure your code passes linting: npm run lint
• To create the build: npm run build

Login

During login, if your see Invalid URL: http://localhost:3000 error in browser console, just browse http://localhost:3000 and it will show up.

Or, you can add into your /etc/hosts the line 127.0.0.1 local.topcoder-dev.com. And access the app with http://local.topcoder-dev.com:3000. It will prevent you from getting Invalid URL: http://localhost:3000 and you will be redirected successfully after login.

Contributing

Pull Requests

To contribute to the repository, please create a feature branch off of the dev branch. Once you're finished working on the feature, make a pull request to merge it into dev. Please make sure that every pull request has passed the build checks, which appear just before the "Merge pull request" button in github.

Updating npm-shrinkwrap.json

General workflow to update npm-shrinkwrap.json would be:

• npm install --no-optional - with old npm-shrinkwrap (--no-optional to skip fsevents)
• update package.json if you need to remove/update/add any packages
• remove npm-shrinkwrap.json
• npm install --no-optional with new package.json
• npm shrinkwrap - to convert package-lock.json to npm-shrinkwrap.json
• the new npm-shrinkwrap.json will have just the minimal diff

Code Style

Checkout the code and comments in src/components/ExampleComponent for an example React component, .scss file, and tests.

React

• Most components should be stateless and use the functional component pattern
• If you need a stateful component, use ES6 classes
• Always use PropTypes for all props
• Use classnames for dynamic classes. See ExampleComponent for an example.

JavaScript

• Make sure your variable names are easy to understand and descriptive. No acronyms, except for common ones like i or err.
• Use lodash and functional JavaScript if it makes the code clearer.
• Please use ES2015 syntax whenever possible
• Specific rules are enforced via .eslintrc.json
• Run npm run lint to check your code against the linter

SCSS Files

• This repository uses flexbox for arranging content
• The use of any extra CSS libraries should be discussed with the team
• Use SCSS syntax, but do not overly nest
• Use 2 spaces for indentation
• Use variables, mixins, and classes as much as possible from our style guide
• To include variables from the style guide mentioned above, place @import 'topcoder/tc-includes;' at the top of your .scss file. Locally, you can look in ./node_modules/appirio-styles/styles/topcoder/_tc-colors.scss to find many colors already defined (e.g. #A3A3AE => $accent-gray)
• When adding media queries, nest them inside the element, rather than creating a new section

@import 'topcoder/tc-includes;'

$my-local-var: 50px;

.box {
  height: $my-local-var;
  width: 50px;
  color: $medium-gray;
  @media screen and (min-width: 768px) {
    height: 100px;
    width: 100px;
    color: $dark-gray;
  }

  .inside-box {
    font-size: 14px;
    @media screen and (min-width: 768px) {
      font-size: 18px;
    }
  }
}
SVG Icons
- This repository uses plugin babel-plugin-inline-react-svg 
- The plugin is used to inline-embed svg icons inside the markup

Steps to adding new icons
- Insert the svg file in the ~/src/assets/images/ directory 
- Add a new icon component file in directory ~/src/components/Icons/Icon-Name.jsx and reference it on the global 
  icon component in the ~/src/components/icons/ directory
- Wrap the svg icon inside an object for caching to optimize on perfomance.

Writing Tests

• npm test will run the current tests
• npm run test:watch will rerun tests when files change
• Place your test files in the same directory as the component it's testing
• Test files should be named ComponentName.spec.js
• Checkout the ExampleComponent directory in /src/components

Recommended Developer Tools

Syntax highlighting for ES6 and React JSX

• Install babel via the package manager in Sublime Text
  • Note: Sublime Text 3 is required for this plugin
• Set the plugin as the default syntax for a particular extension
  • Open a file with the .js extension
  • Select View from the menu
  • Then Syntax -> Open all with current extension as...
  • Then Babel -> JavaScript (Babel)
  • Repeat for any other extensions, e.g. .jsx

Recommended Theme

• Install Oceanic Next Color Theme via the Sublime Text package manager.
• Add the following to Sublime Text -> Preferences -> Settings-User (⌘ + , on Mac)

{
  "color_scheme": "Packages/Oceanic Next Color Scheme/Oceanic Next.tmTheme",
  "theme": "Oceanic Next.sublime-theme"
}

Automatic JavaScript linting in Sublime Text

• Install SublimeLinter following the instructions under "Installing via Package Control"
• Install SublimeLinter-eslint with the package manager. The package is called SublimeLinter-contrib-eslint

Code expander

• Examples:
  • div.cool-class becomes <div className="cool-class"></div>
  • a becomes <a href=""></a>
• Install Emmet via Sublime Text package manager
• Configure Emmet to work with React, e.g. classes expand to className instead of class
• Follow the instructions under Get Emmet working
  • Note: Add the last snippet of code to reg_replace.sublime-settings by navigating to Sublime Text -> Preferences -> Package Settings -> Reg Replace -> Settings-User

© 2017 Topcoder. All Rights Reserved