|
1 | | -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
2 | | - |
3 | | -## Available Scripts |
4 | | - |
5 | | -In the project directory, you can run: |
6 | | - |
7 | | -### `npm start` |
8 | | - |
9 | | -Runs the app in the development mode.<br /> |
10 | | -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
11 | | - |
12 | | -The page will reload if you make edits.<br /> |
13 | | -You will also see any lint errors in the console. |
14 | | - |
15 | | -### `npm test` |
16 | | - |
17 | | -Launches the test runner in the interactive watch mode.<br /> |
18 | | -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
19 | | - |
20 | | -### `npm run build` |
21 | | - |
22 | | -Builds the app for production to the `build` folder.<br /> |
23 | | -It correctly bundles React in production mode and optimizes the build for the best performance. |
24 | | - |
25 | | -The build is minified and the filenames include the hashes.<br /> |
26 | | -Your app is ready to be deployed! |
27 | | - |
28 | | -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
29 | | - |
30 | | -### `npm run eject` |
31 | | - |
32 | | -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** |
33 | | - |
34 | | -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. |
35 | | - |
36 | | -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. |
37 | | - |
38 | | -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. |
39 | | - |
40 | | -## Learn More |
41 | | - |
42 | | -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
43 | | - |
44 | | -To learn React, check out the [React documentation](https://reactjs.org/). |
45 | | - |
46 | | -### Code Splitting |
47 | | - |
48 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting |
49 | | - |
50 | | -### Analyzing the Bundle Size |
51 | | - |
52 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size |
53 | | - |
54 | | -### Making a Progressive Web App |
55 | | - |
56 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app |
57 | | - |
58 | | -### Advanced Configuration |
59 | | - |
60 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration |
61 | | - |
62 | | -### Deployment |
63 | | - |
64 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/deployment |
65 | | - |
66 | | -### `npm run build` fails to minify |
67 | | - |
68 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify |
| 1 | +# UBahn App |
| 2 | + |
| 3 | +## Install software |
| 4 | + |
| 5 | +- node 12.x |
| 6 | +- npm 6.x |
| 7 | +- docker |
| 8 | +- S3 |
| 9 | + |
| 10 | +## Deployment |
| 11 | + |
| 12 | +There are two apps involved - a front end build using create react app and a backend which is a nodejs api |
| 13 | + |
| 14 | +When working locally, you will run the following commands (after setting the necessary environment variables): |
| 15 | + |
| 16 | +- npm install |
| 17 | +- cd client && npm install |
| 18 | +- cd .. && npm run dev |
| 19 | + |
| 20 | +The front end proxies request (some of them) to localhost:3001, which is the backend api code base. This configuration is located in `client/package.json` file itself |
| 21 | + |
| 22 | +Note that the environment variables for the React App start with REACT_APP_ |
| 23 | + |
| 24 | +## Local database deployment |
| 25 | + |
| 26 | +1. Navigate to docker-db run `docker-compose up -d` |
| 27 | +2. Follow *Configuration* section to update config values |
| 28 | +3. Run `npm i` and `npm run lint` |
| 29 | +4. Create table, `npm run create-tables`, this will create tables (if you need this) |
| 30 | +5. Startup server `npm run start` |
| 31 | + |
| 32 | +## Configuration |
| 33 | + |
| 34 | +Configuration for the application is at `config/default.js` and `config/production.js`. The following parameters can be set in config files or in env variables: |
| 35 | + |
| 36 | +- LOG_LEVEL: the log level |
| 37 | +- PORT: the server port |
| 38 | +- API_VERSION: the API version |
| 39 | +- AUTH_SECRET: TC Authentication secret |
| 40 | +- VALID_ISSUERS: valid issuers for TC authentication |
| 41 | +- AMAZON.AWS_ACCESS_KEY_ID: The AWS access key |
| 42 | +- AMAZON.AWS_SECRET_ACCESS_KEY: The AWS secret key |
| 43 | +- AMAZON.AWS_REGION: The Amazon region to use when connecting. For local dynamodb you can set fake value. |
| 44 | +- AMAZON.IS_LOCAL_DB: Use local or AWS Amazon DynamoDB |
| 45 | +- AMAZON.DYNAMODB_URL: The local url, if using local Amazon DynamoDB |
| 46 | +- AMAZON.DYNAMODB_READ_CAPACITY_UNITS: the AWS DynamoDB read capacity units, if using local Amazon DynamoDB |
| 47 | +- AMAZON.DYNAMODB_WRITE_CAPACITY_UNITS: the AWS DynamoDB write capacity units, if using local Amazon DynamoDB |
| 48 | +- AMAZON.DYNAMODB_UPLOAD_TABLE: DynamoDB table name for upload |
| 49 | +- AMAZON.DYNAMODB_TEMPLATE_TABLE: DynamoDB table name for template |
| 50 | +- AUTH0_URL: Auth0 URL, used to get TC M2M token |
| 51 | +- AUTH0_AUDIENCE: Auth0 audience, used to get TC M2M token |
| 52 | +- TOKEN_CACHE_TIME: Auth0 token cache time, used to get TC M2M token |
| 53 | +- AUTH0_CLIENT_ID: Auth0 client id, used to get TC M2M token |
| 54 | +- AUTH0_CLIENT_SECRET: Auth0 client secret, used to get TC M2M token |
| 55 | +- AUTH0_PROXY_SERVER_URL: Proxy Auth0 URL, used to get TC M2M token |
| 56 | +- BUSAPI_URL: the bus api, default value is `https://api.topcoder-dev.com/v5` |
| 57 | +- KAFKA_ERROR_TOPIC: Kafka error topic, default value is 'common.error.reporting' |
| 58 | +- KAFKA_MESSAGE_ORIGINATOR: the Kafka message originator, default value is 'ubahn-search-ui-api' |
| 59 | +- UPLOAD_CREATE_TOPIC: the upload create Kafka topic, default value is 'ubahn.action.create' |
| 60 | +- TEMPLATE_FILE_MAX_SIZE: the template file restrict size, default value is '2MB' |
| 61 | +- TEMPLATE_FILE_MIMETYPE: the template file accept type, default value is 'application/vnd.ms-excel,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' |
| 62 | +- TEMPLATE_S3_BUCKET: the template s3 bucket name, default value is 'ubahn' |
| 63 | +- UPLOAD_S3_BUCKET: the upload s3 bucket name, default value is 'ubahn' |
| 64 | +- S3_OBJECT_URL_EXPIRY_TIME: the s3 url expiry time, default value is '1 hour' |
| 65 | + |
| 66 | +Also check out the client folder's README file for additional configurations to set for the front end. You can find the required configurations under client/src/config.js |
0 commit comments