This article will walk you through setting up an Awesome Code project. For a video introduction to Awesome Code, you can view our overview video.

Creating Your Account

To create your account, you just need to click “Sign In With Github” button or “Sign In With Bitbucket” button.

quickstart getting started 0

Connecting Your Project

Click “Create a Project” link.

quickstart getting started 1

Choose Your SCM github or bitbucket.

quickstart getting started 2

Fill in the project clone url then click “Connect” button.

quickstart getting started 3

Now you project is already connected to Awesome Code, you just need to push a commit to trigger build on Awesome Code or click “Trigger Now” to trigger with an empty commit.

quickstart getting started 4

Starting Your First Build

After a new commit is pushed, Awesome Code will analyze your source code.

quickstart getting started 5

And show you how to improve your code quality. You can push a commit directly or send a pull request to fix it.

quickstart getting started 6

After several improvements from Awesome Code, you will see the git log like

quickstart getting started 7