Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 11 additions & 24 deletions README.md
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.
Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Collaborator

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.


- 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.
28 changes: 0 additions & 28 deletions config/env.js

This file was deleted.

1 change: 0 additions & 1 deletion config/jest/CSSStub.js

This file was deleted.

1 change: 0 additions & 1 deletion config/jest/FileStub.js

This file was deleted.

57 changes: 0 additions & 57 deletions config/paths.js

This file was deleted.

14 changes: 0 additions & 14 deletions config/polyfills.js

This file was deleted.

198 changes: 0 additions & 198 deletions config/webpack.config.dev.js

This file was deleted.

Loading