Simplify development setup - Githubissues

awslabs / aws-api-gateway-developer-portal

A Serverless Developer Portal for easily publishing and cataloging APIs

Apache License 2.0

928 stars 400 forks source link

Simplify development setup #380

Closed ghost closed 4 years ago

ghost commented 4 years ago

Issue #, if available:

Description of changes:

The bulk of the meaningful changes are in this commit.
- I recasted the scripts to automate most of the manual stuff away. In particular, installing all the dependencies and getting your dev environment set up is a single simple, easy command.
- I revised the setup to make it a much more fluid process to get started.
- I hand-rolled a task runner to reduce a lot of the otherwise necessary shell magic.
- I removed dependency on OS-dependent utilities like cp and rm at build time. (I also killed a script's unnecessary dependency on zsh.)
- I moved all the scripts from dev-portal to the root so it's easier to work with in the general case.
- I now revert the generated static assets to the currently checked-out versions after deploying as part of the "release" task, to avoid accidentally committing regenerated assets in that common case. (You can still manually build and deploy without resetting, just not through node run release.)
The rest of the commits are atomic and explain it very well.

Note: this has no impact on the developer portal as deployed through this repo. It's all just DX improvements.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

ghost commented 4 years ago

Here's the real diff for this PR: https://github.com/awslabs/aws-api-gateway-developer-portal/compare/staging..63d731616d60978e2d4c856b445ac468314e5fa0

Edit: Updated link Edit 2: Updated link