Jobs4You API

This is a simple implementation of an interface to the github jobs api. Our plan here is to:

1. Use Python as our language for the backend, PipEnv not only to manage the packages but also to allow us making use of Pipfile.
2. Use vanilla javascript, css and html to do the necessary front-end part. I intend to create a very simple front-end.
3. I am not quite sure whether I should collect the jobs asyncronously to feed the database in order to optimize the queries. As it is not clear to me when reading the description, I will proceed with the simplest solution as this is expected to be done within a week. If I were to do this, I would either use another language for this, like NodeJS or GO, to fill the database in another repository, or use celery with async tasks here.
4. As a way to improve the queries, I'll make use of Redis to cache the results, however, I will set a very short TTL as I suppose that there are new jobs and jobs getting filled in a high frequency.
5. I will make use of Connexion and OpenAPI to create a documentation for the API and to check the input and our API response.
6. I will use Docker to set up the application, the database and the redis instance.
7. I will deploy this application to heroku.

After finishing notes:

1. I also setup a nginx to proxy the requests to the API and serve the front-end.
2. I'm not deploying to heroku as heroku does not support docker-compose but rather a heroku.yml file. To do it so, I would need more time to create this file. As the repository can be builded in a very simple way, I discarded this option.
3. The whole repository where created between 12-16hs, distributed through 4 days. I can't tell exactly because I had to deal with a lot of different things while developing this.
4. This was a very simple technical challenge. I tried to put the most possible things on the backend but yet, making it in a short time.

How to run

Dependencies

This repository depends on the usage of:

• Docker
• Docker-Compose

If you want to run locally, you will also need:

• PipEnv

Building

To build the project, use:

$ docker-compose up

Start

To start the project, use:

$ docker-compose start

If you want to run locally but make use of the database only, you can run:

$ docker-compose start postgres migrations

With the database started, you can use the pipenv locally or in the container:

$ pipenv install
$ pipenv shell
$ pipenv run local

Note that, to change the code in the container as you change in the repo, you'll need to add a volumes on the docker-compose file. Also, observe that local is a script inside Pipfile that starts a local development server to make usage of auto-reloading and debugging.

Tests

To run the tests, you can use:

$ pipenv install
$ pipenv shell
$ pipenv run tests

How to use

Documentation

For the API documentation, you can check on the following url:

{URL}/api/ui -> localhost/api/ui

You can also try the endpoints if the API is running locally.

There's one hidden endpoint from the API documentation that is used only to know whether the server is alive: liveness.

Admin

To connect to the Admin and have access to read and change the database, you can use the following url:

{URL}/api/admin -> localhost/api/admin

To connect, the default user/password is jobs4youmanager/admin. If you're going to use this somewhere else, set up the correct environment variables to change the admin's user and password.

PipEnv Autohooks

This repository is making use of Pipenv autohooks to auto-format the code using black.

This is installed running:

$ pipenv run autohooks activate
$ pipenv run autohooks check