An open API service indexing awesome lists of open source software.

https://github.com/wesgtox/fpso-management

Floating Production Storage and Offloading management API.
https://github.com/wesgtox/fpso-management

api api-rest django django-rest-framework docker docker-compose python

Last synced: about 1 month ago
JSON representation

Floating Production Storage and Offloading management API.

Awesome Lists containing this project

README

          


FPSO Management


About  |  
Technology  |  
Getting Started  |  
Usage  |  
License


FPSO Management CI
GitHub top language
GitHub language count
GitHub last commit
GitHub issues
License

## About the Project

FPSO Management is a vessel and equipment management API, with registration, updating specific listings.

## Technology

This project was developed with the following technologies:

- [Python](https://www.python.org/)
- [Django Framework](https://www.djangoproject.com/)
- [Django REST Framework](https://www.django-rest-framework.org/)
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)

## Getting Started

### Prerequisites

- [Python](https://www.python.org/)
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)

### Install and Run

1. Clone the repository:
```bash
git clone https://github.com/WesGtoX/fpso-management.git
```
2. Set a `SECRET_KEY` in `.env`:
```bash
cp .env.sample .env
```
3. Run:
```bash
make run
```
4. Run tests:
```bash
make test
```
5. To create a user with administrative access:
```bash
make user
```
6. To access the administrative area:
```bash
http://127.0.0.1:8000/admin
```

## Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Documentation](https://github.com/WesGtoX/fpso-management/wiki)_

## License

Distributed under the MIT License. See [LICENSE](LICENSE) for more information.

---

Made with ♥ by [Wesley Mendes](https://wesleymendes.com.br/) :wave: