Skip to content

Latest commit

 

History

History
118 lines (73 loc) · 4.43 KB

File metadata and controls

118 lines (73 loc) · 4.43 KB

Instructions for challenged

This project is already prepared with a instructions for you to create a docker image and run it so that you have your api environment without the need to configure the entire project.

Follow the instructions below to carry out the procedure.

News

Now, the challenges are available in the cloud as I have deployed the API to streamline the initial access. Check out the documentation at: https://dev-challenge.micheltlutz.me/docs. However, you still have the option to use the challenges locally, either by using Docker or by setting up the Python environment.

Requirements to run local

  • Terminal

For Linux

For macOS

Windows

Attention!: If you are using Windows, you need to run the terminal as administrator.

Prefer Rancher Desktop, it is free, more complete and has more features

1. Create Image

docker build -t "dev-challenge" .

2. Check if image was created

docker images

3. Run container

docker run -d --name dev-challenge-demo -p 8000:8000 dev-challenge:latest

4. Check if container is running

docker ps

5. Access the API

Stop container

When you need to stop the container, run the code below in your terminal

docker stop dev-challenge-demo

Api Documentation information

The project documentation uses swagger, you can access it after running the docker container and accessing the address below in the browser, where you will find the routes, parameters and schemes of each of the routes created for your challenge, in addition to being able to execute the routes directly in the documentation.

Routes with authentication have a padlock icon

Routes with authentication

Schema Example

Challanges

Figma

Access the Figma link to follow the style guide and components in your interfaces.

Front-End

For front-end developers, we provide a ready-to-use API set up to run in a Docker environment or online usage. This API includes routes for listings, authentication, user creation, login, among other features. This allows the developer to focus primarily on the design and implementation of interfaces.

Mobile

For Mobile developers, we provide a ready-to-use API set up to run in a Docker environment or online usage. This API includes routes for listings, authentication, user creation, login, among other features. This allows the developer to focus primarily on the design and implementation of interfaces.

Back-End

The challenge set for back-end developers is to replicate the already developed routes in their preferred programming language and then produce relevant documentation.