SEQUELIZE-CRUD-POSTGRESQL

Developed with the software and tools below.

---

🔗 Quick Links

• 📂 Repository Structure
• 🧩 Modules
• 🚀 Getting Started
  • ⚙️ Installation
  • 🤖 Running sequelize-crud-postgresql
  • 🧪 Tests
• 🤝 Contributing
• 📄 License

---

📂 Repository Structure

└── sequelize-crud-postgresql/
    ├── LICENSE
    ├── README.md
    ├── package.json
    ├── src
    │   ├── config
    │   │   └── database.js
    │   ├── controllers
    │   │   ├── AddressController.js
    │   │   ├── DownloadController.js
    │   │   ├── ReportController.js
    │   │   ├── UserController.js
    │   │   └── VehiclesController.js
    │   ├── database
    │   │   ├── index.js
    │   │   └── migrations
    │   │       ├── 20220923032520-create-users-teste.js
    │   │       ├── 20220924233055-create-count-downs.js
    │   │       ├── 20220925000739-create-addresses.js
    │   │       ├── 20221002224200-create-vehicles.js
    │   │       └── 20221002224821-create-user_vehicle.js
    │   ├── models
    │   │   ├── Address.js
    │   │   ├── Downloads.js
    │   │   ├── Users.js
    │   │   └── Vehicles.js
    │   ├── routes.js
    │   └── server.js
    └── yarn.lock

---

🧩 Modules

.

File	Summary
package.json	package.json
yarn.lock	yarn.lock

src

File	Summary
server.js	src/server.js
routes.js	src/routes.js

src.database

File	Summary
index.js	src/database/index.js

src.database.migrations

File	Summary
20221002224821-create-user_vehicle.js	src/database/migrations/20221002224821-create-user_vehicle.js
20220923032520-create-users-teste.js	src/database/migrations/20220923032520-create-users-teste.js
20221002224200-create-vehicles.js	src/database/migrations/20221002224200-create-vehicles.js
20220925000739-create-addresses.js	src/database/migrations/20220925000739-create-addresses.js
20220924233055-create-count-downs.js	src/database/migrations/20220924233055-create-count-downs.js

src.models

File	Summary
Users.js	src/models/Users.js
Downloads.js	src/models/Downloads.js
Address.js	src/models/Address.js
Vehicles.js	src/models/Vehicles.js

src.config

File	Summary
database.js	src/config/database.js

src.controllers

File	Summary
AddressController.js	src/controllers/AddressController.js
VehiclesController.js	src/controllers/VehiclesController.js
ReportController.js	src/controllers/ReportController.js
UserController.js	src/controllers/UserController.js
DownloadController.js	src/controllers/DownloadController.js

---

🚀 Getting Started

Requirements

Ensure you have the following dependencies installed on your system:

• JavaScript: version x.y.z

⚙️ Installation

1. Clone the sequelize-crud-postgresql repository:

git clone https://github.com/Bruno-Elvis/sequelize-crud-postgresql

2. Change to the project directory:

cd sequelize-crud-postgresql

3. Install the dependencies:

npm install

🤖 Running sequelize-crud-postgresql

Use the following command to run sequelize-crud-postgresql:

node app.js

🧪 Tests

To execute tests, run:

npm test

---

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.
• Report Issues: Submit bugs found or log feature requests for Sequelize-crud-postgresql.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your GitHub account.
2. Clone Locally: Clone the forked repository to your local machine using a Git client.

   git clone https://github.com/Bruno-Elvis/sequelize-crud-postgresql

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to GitHub: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.

---

📄 License

This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.

---

Esta API está integrada ao PostgreSQL em nuvem, disponivel na plataforma ElephantSQL ( https://www.elephantsql.com/ );

Para definição das entidades no banco foi utilizado Migrations junto ao Sequelize.

API rodando em ambiente Heroku ( https://www.heroku.com ), possui os endpoints:

// Users https://sequelize-crud-postgresql.herokuapp.com/users (GET e POST)

// Adresses https://sequelize-crud-postgresql.herokuapp.com/users/:user_id/addresses (GET e POST)

// Vehicles https://sequelize-crud-postgresql.herokuapp.com/users/:user_id/vehicles (GET, POST e DELETE)

// Downloads https://sequelize-crud-postgresql.herokuapp.com/downloads (GET) https://sequelize-crud-postgresql.herokuapp.com/counts (GET)