Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/platzi-master-c8/gethired-jobplacement-ratings-backend
🌟Backend repository for the job placement cell in which we will perform the business logic of the defined Ratings squad.
https://github.com/platzi-master-c8/gethired-jobplacement-ratings-backend
api-rest docker docker-compose fastapi ngnix postgresql pydantic python sqlalchemy uvicorn
Last synced: about 1 month ago
JSON representation
🌟Backend repository for the job placement cell in which we will perform the business logic of the defined Ratings squad.
- Host: GitHub
- URL: https://github.com/platzi-master-c8/gethired-jobplacement-ratings-backend
- Owner: Platzi-Master-C8
- License: mit
- Created: 2021-11-29T15:52:36.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-06T21:26:12.000Z (almost 3 years ago)
- Last Synced: 2023-03-08T05:47:09.117Z (almost 2 years ago)
- Topics: api-rest, docker, docker-compose, fastapi, ngnix, postgresql, pydantic, python, sqlalchemy, uvicorn
- Language: Python
- Homepage: https://18.190.40.7/docs
- Size: 268 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gethired Jobplacement Ratings Backend
🌠 Backend repository for the job placement cell in which we will perform the business logic of the defined Ratings squad.
## 🚀Getting Started
The application is built with this stack:
- [Docker](https://www.docker.com/) 🐋
- [Python](https://www.python.org/) 🐍
- [FastAPI](https://fastapi.tiangolo.com/) 🚀
- [Pydantic ](https://pydantic-docs.helpmanual.io/) 💯
- [PostgreSQL](https://www.postgresql.org/) 🐘
- [SQLAlchemy](https://www.sqlalchemy.org/) ⚙️
To get started you just need to download docker on your machine, I leave the link right here. ➡️ [Docker](https://www.docker.com/get-started "Docker").
## 🧑💻 Database access configuration using the .env file
1. First, Create in the root folder of the project a file named `.env` 📂.
2. Now configure your `.env` with this environment variables with the local credentials of the project below. ⬇️.
```
DB_CONNECTION=postgresql
DB_USERNAME=postgres
DB_PASSWORD=postgres
DB_HOST=postgresql
DB_DATABASE=jobplacement-ratings
DB_PORT=5432
```
## 🐳 Run the Project with Docker
You can run the following command to buil the image.
```
$ docker-compose build
```
Once the image is built, run the container:
```
$ docker-compose up -d
```
If you want to be faster in launching the project you can use the following command to perform the above two steps in one.
```
$ docker-compose up --build
```
## 📑 Interactive API docs
Now go to http://127.0.0.1:8000/docs.
You will see the automatic interactive API documentation (provided by Swagger UI).
