From 41eb81ac38ace67d0869012a70ddf32f3853e7e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guzm=C3=A1n=20Bras=C3=B3?= Date: Tue, 8 Jun 2021 13:50:06 -0300 Subject: [PATCH] Update README.md My two cents... hopefully it would be more clear and easy to read... --- README.md | 53 ++++++++++++++++++++++++++++++----------------------- 1 file changed, 30 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 608b08d..73c963c 100644 --- a/README.md +++ b/README.md @@ -6,64 +6,71 @@ - Have [docker-compose](https://docs.docker.com/compose/install/) installed - Do not have services running on the ports (9191, 8181, 8080 and 2222) -### Test +### Test Summary We will provide a docker image for you, this image will have an enviroment like we have on VIX. It will have: - -- GITEA - software development version control. -- Staging Environment - When you merge something on master this environment will be updated whitin the master branch. (This is not your dev/local env.) +- GITEA - software development version control. - Staging Environment - When you merge something on master this environment will be updated whitin the master branch. (This is not your dev/local env.) - Drone - Continuos Integration/Continuos Delivery - SSH - Secure Shell +The Gitea works like GitHub, you will use the provided user/password to login. Inside Gitea you will find a repository with some issues to resolve. +We expect that you create 1 Pull Request per issue. When every PR CI/CD test pass you can merge it by yourself. + +After you are done you have to submit the image back to us. + +--- + ### Step by Step -In order to proceed here you have to have all the [requirements](https://github.com/vixtech/mobile-test#requirements). +1. Make sure you are ready + +In order to proceed to the next step you must have all the [requirements](https://github.com/vixtech/mobile-test#requirements). -##### Clone the Repo +2. Clone the Repo ```bash git clone https://github.com/vixtech/mobile-test.git ``` -#### Run the docker image +3. Run the docker image inside the project directory -Inside the project directory. ```bash docker-compose up + ``` -#### Access all the services with your browser +4. Verify you can access all the services with your browser: + +- [Gitea](http://localhost:9191): User: candidate, Password: changeit +- [Staging enviroment](http://localhost:8181): All the code that is merged to master is deployed in this environment. +- [Drone](http://localhost:8080): Drone is our CI/CD application, it will run the pipeline for all commit we push to the repo. -- [Gitea](http://localhost:9191) (User: candidate, Password: changeit) -> The Gitea works like GitHub, you will use the provided user/password to login, and there you will have a repository with some issues to resolve. We expect that you create 1 Pull Request per issue. When all tests of the Pull Request CI/CD pass you can merge the PR yourself. We also expect that you match the PR in the issue and may update the issue with additional info. -- [Staging enviroment](http://localhost:8181) -> All the code that is merged to master is deployed in this environment. -- [Drone](http://localhost:8080) -> Drone is our CI/CD application, it will run the pipeline for all commit we push to the repo. +5. Happy bugfixing! +--- -#### After you solve the test +### Submit your test -Commit the available container by just executing this command: +After you are done with the test we need you to commit your container, log into docker and push your fixes to your docker-bub account. -**Change the** `change-here-for-your-docker-hub-username` **for your docker-hub username** +Please execute the next 4 steps: + +1. Commit the available container ( _**change the** `change-here-for-your-docker-hub-username` **for your docker-hub username**_ ) ```bash docker commit $(docker ps | grep mobile-test | awk '{print $1}') change-here-for-your-docker-hub-username/mobile-test ``` -Then make a docker login: +2. Log into docker-hub ```bash docker login ``` -Then push the image. - -**Change the** `change-here-for-your-docker-hub-username` **for your docker-hub username** +3. Push your image ( _**change the** `change-here-for-your-docker-hub-username` **for your docker-hub username**_ ) ```bash docker push change-here-for-your-docker-hub-username/mobile-test ``` -Send us back +4. Send us back