https://github.com/malaquiasdev/thepixardb
The Pixar Database API
https://github.com/malaquiasdev/thepixardb
api-rest aws beginner-friendly hacktoberfest nodejs pixar-films terraform thepixardb typescript
Last synced: 3 months ago
JSON representation
The Pixar Database API
- Host: GitHub
- URL: https://github.com/malaquiasdev/thepixardb
- Owner: malaquiasdev
- License: mit
- Created: 2022-03-28T10:54:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-07T20:26:26.000Z (over 4 years ago)
- Last Synced: 2025-04-09T15:54:11.983Z (over 1 year ago)
- Topics: api-rest, aws, beginner-friendly, hacktoberfest, nodejs, pixar-films, terraform, thepixardb, typescript
- Language: HCL
- Homepage: https://thepixardb.malaquias.dev/
- Size: 454 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ThePixarDB
**ThePixarDB** is an centralized database of the feature filmes, short filmes, collections, actors, directors and much more. We have all the data you'll ever need in one place, easily accessible through with a modern RESTful API.
**It is unofficial and we are made by fans to fans.**
This project is a RESTful API and will be a GraphQL API too.
## Setup Local - Docker and Compose 🗳️
We are using docker for create a local environment. The process is managed by Docker Compose.
This setup it's not recommend to create a production environment, for that we have a terraform module inside of the infra folder.
You can start everthing by:
```bash
docker-compose up --build
```
## Setup Local 🖥️
### Prerequisites 📝
Before you begin, ensure you have met the following requirements:
- You must have an AWS Credentials
- Configure the [AWS CLI](https://aws.amazon.com/pt/cli/)
- You have installed the [Node.js](https://nodejs.org/en/)
- You have installed the [Yarn](https://yarnpkg.com)
- You have installed the [Terraform](https://www.terraform.io)
### Create the infra on AWS 🏗️
```
cd infra && terraform init && terraform terraform apply -auto-approve
```
#### Install dependencies 🚀
```sh
$ yarn install
```
### Create configs
Create a `.env` file at the root of the project. Make sure you follow the [`.env.example`](.env.example) file as a guide.
### Run project
```sh
$ yarn dev
```
## Testing
## To know more
- [About](https://thepixardb.malaquias.dev/about/)
- [Features list]()
## Terms of Use
1. Free for non-commercial use.
2. You can make use of the API as data service.
3. ‘Hoarding’ or mass collection of data from this API is strictly prohibited.
## Legal Notice
We do not claim ownership of any of the images or data in the API. We comply with the Digital Millennium Copyright Act (DMCA) and expeditiously remove infringing content when properly notified. Any data and/or images you upload you expressly grant us a license to use. You are prohibited from using the images and/or data in connection with libelous, defamatory, obscene, pornographic, abusive or otherwise offensive content.
## How to contribute
Go to [contribute](.github/CONTRIBUTING.md)
## License
[](/LICENSE)