forked from modelab/DynamoDictionary_React
-
Notifications
You must be signed in to change notification settings - Fork 17
Modernize development build & dependencies #30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,22 @@ | ||
| # DynamoDictionary | ||
|
|
||
| Dynamo Dictionary development repo | ||
|
|
||
| Live version here: http://dictionary.dynamobim.com | ||
|
|
||
| ## Installation | ||
| - Version 8 of Node is required. Later versions of Node are known to cause installation problems. | ||
| - In root directory, type ```npm install``` into the command line. | ||
| - If you find that the command hangs, feel free to use `yarn` instead of `npm`. | ||
| - In public directory, ```run bower install mocha```, ```bower install requirejs``` and ```bower install blanket```. | ||
| Make sure Bower package manager is already installed.These dependencies will be downloaded into a new folder 'bower_components'. | ||
|
|
||
| ## Run in Development Mode | ||
| - In root directory, type ```npm run start``` into the command line. | ||
|
|
||
| ## Deploy to Autodesk (Staging) | ||
|
|
||
| - Confirm that `homepage` in `package.json` is set to `http://staging-dictionary.dynamobim.com/`. The developer may change this address depending on the staging environment. | ||
|
|
||
| - In root directory: ```npm run build```, in case of new changes, ensure that links pointing to `static` resources in the `index.html` file are correct (i.e are pointing to assets inside the `/2` directory). | ||
|
|
||
| - Copy files from `build` folder and place into the root directory of the [Autodesk Dynamo Dictionary repo](https://github.com/DynamoDS/DynamoDictionary), in the appropriate `branch`. | ||
|
|
||
| - You may need to invalidate the cache (AWS CloudFront), in order to view the latest changes. | ||
| - Node.js version 12 is required. [Download the installer here](https://nodejs.org) (or use [nvm](https://github.com/nvm-sh/nvm).) | ||
| - Run `npm install` from the command line in the project root directory. | ||
|
|
||
| - To view `2.x` version, you may have to manually enter the correct staging URL in the address bar, as the UI links may still point to production. | ||
| ## Run the Development Server | ||
| - Run `npm start` from the command line in the project root directory. | ||
| - A browser window with the development site at http://localhost:3000 should open automatically. It may take a few seconds for the site to appear the first time. | ||
|
|
||
| ## Deploy to Autodesk (Production) | ||
| ## Build the Static Deployment | ||
|
|
||
| - Confirm that `homepage` in `package.json` is set to `http://dictionary.dynamobim.com/`. The developer may change this address depending on the staging environment. | ||
| - Run `npm run build` from the command line in the project root directory. | ||
| - To test serving the static files locally, run `npx serve -s build`. | ||
| - Open the local static site at http://localhost:5000. | ||
|
|
||
| - In root directory: ```npm run build``` | ||
| ## Deploying | ||
|
|
||
| - Copy files from `build` folder and place into the root directory of the [Autodesk Dynamo Dictionary repo](https://github.com/DynamoDS/DynamoDictionary), in the appropriate `branch`. | ||
| - Refer to internal documentation. | ||
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
were these docs moved somewhere internal? I think @zeusongit just documented these here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Usually it's not a good idea to make staging environments public, so the change makes sense.