You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-41Lines changed: 32 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,32 @@
1
-
#### For folks working on this code base, we're organizing coding style and general guidelines [here](https://github.com/appirio-tech/connect-app/wiki/Community-Work-Read-Me-First!).
1
+
#Topcoder Connect App
2
2
3
-
# TC Deployment Notes
3
+
Topcoder Connect is client facing application of Topcoder. Customers use Topcoder Connect to input requirements of their projects, then managers and
4
+
copilots take it from there.
5
+
6
+
## Requirements
7
+
8
+
- Node.js 8+
9
+
- Npm 5+
10
+
11
+
## Run locally for development
12
+
13
+
Prior to running the application locally you should add into your `/etc/hosts` the line `127.0.0.1 local.topcoder-dev.com`.
14
+
15
+
-`$ npm install` - Installs all dependencies.
16
+
-`$ npm start` - Run application in development mode against Topcoder development environment using [dev](https://github.com/appirio-tech/connect-app/blob/dev/config/constants/dev.js) config. In this case the frontend is build in memory by webpack server and uses dev tools like redux-logger.
17
+
18
+
Open browser with URL http://local.topcoder-dev.com:3000.
19
+
20
+
## NPM commands
21
+
22
+
-`$ npm start` - Run application in development mode against Topcoder development environment. In this case the frontend is build in memory by webpack server and uses dev tools like redux-logger.
23
+
-`$ npm build` - Create build for production in `/dest` folder. In this case built app is configured to run against Topcoder production environment using [prod](https://github.com/appirio-tech/connect-app/blob/dev/config/constants/master.js) config. Files are being minimized and `gzipped`.
24
+
-`$ npm run lint` - Check js code linting.
25
+
-`$ npm run lint:fix` - Check js code linting and trying to fix errors automatically.
26
+
-`$ npm run test` - Performs tests running. **Note** we don't really have tests, so we only keep this command run successfully.
27
+
-`$ npm run test:watch` - Performs tests on files changes.
28
+
29
+
## TC Deployment Notes
4
30
_[TC Deployment Notes should always be kept up to date **on the default branch**. Update these notes when changes to this information occur]_
5
31
6
32
**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).
@@ -18,47 +44,12 @@ _[TC Deployment Notes should always be kept up to date **on the default branch**
18
44
* The _circle.yml_ file controls the build - see this file if you need to confirm if your commit will deploy anything
19
45
* Circle-ci builds can be easily cancelled - please do so if you accidentally trigger an undesired build
20
46
21
-
# Customer-App
22
-
23
-
This repository houses new Customer pages, using React, Redux, and Webpack.
24
-
25
-
## Installation
26
-
27
-
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](https://github.com/creationix/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.
28
-
29
-
Install dependencies by running the following in the root of the project:
30
-
-`npm i`
31
-
-**Note:** You must use npm 6.x. Type `npm -v` to ensure you have the correct version.
32
-
33
-
## NPM Commands
34
-
- To run locally, run `npm start` and head to `http://localhost:3000/new_project`
35
-
- Run tests with `npm test` or use `npm run test:watch` to rerun tests after files change
36
-
- To make sure your code passes linting: `npm run lint`
37
-
- To create the build: `npm run build`
38
-
39
-
## Login
40
-
41
-
During login, if your see `Invalid URL: http://localhost:3000` error in browser console, just browse http://localhost:3000 and it will show up.
42
-
43
-
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.
44
-
45
47
## Contributing
46
48
47
49
### Pull Requests
48
50
49
51
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.
50
52
51
-
### Updating npm-shrinkwrap.json
52
-
53
-
General workflow to update `npm-shrinkwrap.json` would be:
54
-
55
-
-`npm install --no-optional` - with old npm-shrinkwrap (--no-optional to skip fsevents)
56
-
- update `package.json` if you need to remove/update/add any packages
57
-
- remove `npm-shrinkwrap.json`
58
-
-`npm install --no-optional` with new `package.json`
59
-
-`npm shrinkwrap` - to convert `package-lock.json` to `npm-shrinkwrap.json`
60
-
- the new `npm-shrinkwrap.json` will have just the minimal diff
61
-
62
53
### Code Style
63
54
64
55
***Checkout the code and comments in `src/components/ExampleComponent` for an example React component, `.scss` file, and tests.***
@@ -107,12 +98,12 @@ SCSS Files
107
98
}
108
99
}
109
100
SVG Icons
110
-
- This repository uses plugin babel-plugin-inline-react-svg
101
+
- This repository uses plugin babel-plugin-inline-react-svg
111
102
- The plugin is used to inline-embed svg icons inside the markup
112
-
103
+
113
104
Steps to adding new icons
114
-
- Insert the svg file in the ~/src/assets/images/ directory
115
-
- Add a new icon component file in directory ~/src/components/Icons/Icon-Name.jsx and reference it on the global
105
+
- Insert the svg file in the ~/src/assets/images/ directory
106
+
- Add a new icon component file in directory ~/src/components/Icons/Icon-Name.jsx and reference it on the global
116
107
icon component in the ~/src/components/icons/ directory
117
108
- Wrap the svg icon inside an object for caching to optimize on perfomance.
0 commit comments