https://github.com/legolasvzla/talana_challenge
https://github.com/legolasvzla/talana_challenge
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/legolasvzla/talana_challenge
- Owner: LegolasVzla
- License: mit
- Created: 2020-11-02T22:43:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-09T23:32:25.000Z (over 4 years ago)
- Last Synced: 2025-01-23T11:19:49.574Z (3 months ago)
- Language: Python
- Size: 26.4 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# talana_challenge
## Technologies
- [Django](https://www.djangoproject.com/) the web framework for perfectionists with deadlines.
- [Django REST framework](https://www.django-rest-framework.org/) is a powerful and flexible toolkit for building Web APIs.
- [PostgreSQL](https://www.postgresql.org/) is the World's Most Advanced Open Source Relational Database.
- [Celery](https://pypi.org/project/django-celery/) Distributed Programming framework for Python.
- [Flower - Celery](https://flower.readthedocs.io/en/latest/) is a web based tool for monitoring and administrating Celery clusters
- [RabbitMQ](https://www.rabbitmq.com/) is the most widely deployed open source message broker.
## Installation
Clone this project:
git clone https://github.com/LegolasVzla/talana_challenge
```Makefile``` will help you with all the installation. First of all, in ```talana_challenge/backend/``` path, execute:
make setup
This will install PostgreSQL and pip on your system. After that, you need to create and fill up **settings.ini** file, with the structure as below:
[postgresdbConf]
DB_ENGINE=django.db.backends.postgresql
DB_NAME=
DB_USER=
DB_PASS=
DB_HOST=
DB_PORT=
[timeZone]
TIME_ZONE = UTC
[emailConfig]
EMAIL_HOST=
EMAIL_PORT=
EMAIL_HOST_USER=
EMAIL_HOST_PASSWORD=
EMAIL_USER_TLS=True
[rabbitMQConfig]
RABBITMQ_USER=
RABBITMQ_PASS=
[frontendClient]
FRONTEND_DOMAIN=
FRONTEND_PORT=
- postgresdbConf section: fill in with your own PostgreSQL credentials. By default, DB_HOST and DB_PORT in PostgreSQL are localhost/5432 and db_challenge the database.
- frontendClient section: refers to the frontend port
- emailConfig section: if you use gmail domain, fill up ```EMAIL_HOST = smtp.gmail.com``` and ```EMAIL_PORT = 587```. Remember to activate [Unsafe application access](https://myaccount.google.com/lesssecureapps) of your email account.
- rabbitMQConfig section: by default ```RABBITMQ_USER``` and ```RABBITMQ_PASS``` are ```guest```
Then, activate your virtualenv already installed (by default, is called ```env``` in the ```Makefile```):
source env/bin/activate
And execute:
make install
This will generate the database with default data and also it will install python requirements and nltk resources. Default credentials for admin superuser are: [email protected] / admin.
Run django server (by default, host and port are set as 127.0.0.1 and 8000 respectively in the ```Makefile```):
make execute
You could see swagger doc in:
http://127.0.0.1:8000/swagger/
In another terminal, run celery:
make celery
Optionally you can run flower in another terminal too:
make flower
You can monitoring rabbitMQ in:
http://localhost:15672/#/
## Swagger Documentation
[Swagger UI](https://swagger.io/tools/swagger-ui/) is a tool for API documentation. "Swagger UI allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without having any of the implementation logic in place. It’s automatically generated from your OpenAPI (formerly known as Swagger) Specification, with the visual documentation making it easy for back end implementation and client side consumption."
This project uses [drf-yasg - Yet another Swagger generator](https://github.com/axnsan12/drf-yasg)
## Endpoints and Actions:
Endpoint Path |HTTP Method | CRUD Method | Used for
-- | -- |-- |--
`api/user/create_account/` | POST | Create user account. This endpoint will send you the email with the link to activate your account
`api/user/verify_account/` | POST | Verify user account from email activation
`api/user/generate_password/(?P\d+)`| POST | Generate password to an user account
`api/user/choose_winner/` | POST | Generate a winner