https://github.com/guligon90/uac-registry
Technical assessment for the position of back-end engineer at @neoprospecta.
https://github.com/guligon90/uac-registry
django django-rest-framework docker docker-compose postgresql python3
Last synced: 3 months ago
JSON representation
Technical assessment for the position of back-end engineer at @neoprospecta.
- Host: GitHub
- URL: https://github.com/guligon90/uac-registry
- Owner: guligon90
- License: mit
- Created: 2020-11-30T18:16:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-07T20:33:48.000Z (over 4 years ago)
- Last Synced: 2025-10-11T19:10:01.359Z (9 months ago)
- Topics: django, django-rest-framework, docker, docker-compose, postgresql, python3
- Language: Python
- Homepage:
- Size: 304 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UAC (User-Address-Client) Registry API [WiP]
Technical assessment for the position of back-end engineer at @neoprospecta.
## Getting started
Make sure that you have installed in your system the latest stable releases of the following tools:
* [Docker](https://docs.docker.com/);
* [Docker Compose](https://docs.docker.com/compose/);
* [Git](https://git-scm.com/);
* [Python (3.8+)](https://www.python.org/downloads/release/python-384/).
### Cloning
To get the code base from this repository, you must open an terminal and execute:
```bash
~ $ git clone https://github.com/guligon90/uac-registry.git
```
### Building
#### Environment
In order to setting up the Python development environment, which is required to manipulate the project building processes via `docker-compose`, you must follow [these](scripts/README.md) instructions.
#### Database
Concerning the database setup, go to this [documentation](./src/database/README.md).
#### Application Server
With the environment all set up, you can now follow the [instructions](./src/backend/README.md) to build the Django application server, which provides the UAC Registry API.
### Usage
With the application server up and running, you can now access the [API documentation](http://localhost:8080/docs). There you can check out the endpoints' detailed specifications, concerning request and response formats.