Getting Started

Once you have downloaded the zip archive for your project, there are only a few things left to get ready for coding.

1. Install dependencies

Goldstack requires a few dependencies to be available in your development system. Please verify they are present or install them:

  • Node v12+
  • Yarn v1.22.5+
  • Docker v19+

Confirm Node version

Open a terminal and run:

node -v

Your Node version must be v12 or later. If you need to update your node version, please see:

  • For OS X[Node Ver]

2. Extract and install

Extract the contents of the zip file into a folder of your choice. After you have done that, you must initialise the project. Simply run the following in your project directory:

yarn

The installation process should take around 3-10 minutes depending on the modules you have selected and your Internet speed.

You can confirm everything was installed correctly by running:

yarn -v

Which should show a yarn version of 2.0.0+.

3. Build modules

Next make sure that everything builds correctly by running the following in your project directory:

yarn build

4. Configure VSCode

Your project should come with all files required to configure VSCode. Configuration files are present in the .vscode/ folder. Simply open the folder of your project in VSCode. If you are asked to allow the installation of additional extensions, please confirm to install them.

If you want to install the necessary extensions manually, here are links to the extensions required:

Next try to find any .ts file in your project. They should be present in one of your modules under packages/*/src/.

Once you open a .ts file, VSCode should open a confirmation at the bottom right corner of the screen asking 'This workspace contains a TypeScript version. Would you like to use the workspace TypeScript version for TypeScript and JavaScript language features?'. Confirm this by clicking the Allow button.

Allow TypeScript

In the status bar on the bottom righthand corner of the VSCode editor you should now see TypeScript along with a version such as 3.9.5-pnpify.

VSCode status bar

If the confirmation dialog does not show up or the version that you see does not include pnpify, click the version number next to TypeScript. Then select the TypeScript version from the list that includes pnpify.

Select TypeScript version

5. Deploy modules

Since you have configured your project, all modules should be ready to be deployed to AWS. We recommend going through each of your modules individually to ensure the infrastructure for them can be deployed successfully. Please see the getting started guides for the templates you have chosen for instructions.

6. Develop

Each module you have selected will provide its own instructions about how to get started with development. However, there are some handy commands in the project root that can be useful for development:

  • yarn build: Will build all modules in the project.
  • yarn compile:watch: Will watch for any changes in your TypeScript files in all modules, and compile them when required. It is essential to have this command running if you develop TypeScript libraries or supporting modules such as S3 or Email Send.
  • yarn test:watch: Will run tests when modules have changed.

Note that you can run all of these commands in the context of individual modules as well. If you only modify code within one module, this is sufficient. However, if you develop multiple modules at the same time, it is important to run these commands at the project root.

© 2020 Pureleap Pty. Ltd. and Contributors