SAT-WEBPAGE API

❯ ESTRUTURA API DA PAGINA WEB SAT

Inclui as tecnologias:

🔗 Table of Contents

• 📍 Overview
• 👾 Features
• 📂 Repository Structure
• 🧩 Modules
• 🚀 Getting Started
  • 🔖 Prerequisites
  • 📦 Installation
  • 🤖 Usage
  • 🧪 Tests
• 📌 Project Roadmap
• 🤝 Contributing
• 🎗 License
• 🙌 Acknowledgments

---

📍 Overview

❯ REPLACE-ME

---

👾 Features

❯ REPLACE-ME

---

📂 Repository Structure

└── sat-webpage/
    ├── package-lock.json
    ├── package.json
    ├── server.js
    └── src
        ├── app.js
        ├── config
        ├── controllers
        ├── migrations
        ├── models
        ├── routes
        ├── seeders
        └── services

---

🧩 Modules

.

File	Summary
package-lock.json	❯ REPLACE-ME
package.json	❯ REPLACE-ME
server.js	❯ REPLACE-ME

src

File	Summary
app.js	❯ REPLACE-ME

src.seeders

File	Summary
20240331142132-rules.js	❯ REPLACE-ME
20240331141304-avaliacao.js	❯ REPLACE-ME

src.config

File	Summary
config.js	❯ REPLACE-ME

src.config.database

File	Summary
db.js	❯ REPLACE-ME

src.controllers

File	Summary
ServicoController.js	❯ REPLACE-ME
Categoria_ServicoController.js	❯ REPLACE-ME
PasswordController.js	❯ REPLACE-ME
UsuarioController.js	❯ REPLACE-ME
EmailController.js	❯ REPLACE-ME
Avaliacao_ServicoController.js	❯ REPLACE-ME
Controller.js	❯ REPLACE-ME
RuleController.js	❯ REPLACE-ME

src.migrations

File	Summary
20240327011623-create-categoria-servico.js	❯ REPLACE-ME
20240331215343-addCredential.js	❯ REPLACE-ME
20240327012101-create-rule.js	❯ REPLACE-ME
20240327012419-create-avaliacao-servico.js	❯ REPLACE-ME
20240327012328-create-servico.js	❯ REPLACE-ME
20240327012124-create-usuario.js	❯ REPLACE-ME

src.models

File	Summary
categoria_servico.js	❯ REPLACE-ME
avaliacao_servico.js	❯ REPLACE-ME
servico.js	❯ REPLACE-ME
usuario.js	❯ REPLACE-ME
index.js	❯ REPLACE-ME
rule.js	❯ REPLACE-ME

src.routes

File	Summary
usuarioRoutes.js	❯ REPLACE-ME
email.js	❯ REPLACE-ME
categoria_servicoRoutes.js	❯ REPLACE-ME
index.js	❯ REPLACE-ME
ruleRoutes.js	❯ REPLACE-ME
password.js	❯ REPLACE-ME
servicoRoutes.js	❯ REPLACE-ME
avaliacao_servicoRoutes.js	❯ REPLACE-ME

src.services

File	Summary
ServicoServices.js	❯ REPLACE-ME
Categoria_ServicoServices.js	❯ REPLACE-ME
UsuarioServices.js	❯ REPLACE-ME
Avaliacao_ServicoServices.js	❯ REPLACE-ME
RuleServices.js	❯ REPLACE-ME
Services.js	❯ REPLACE-ME

---

🚀 Getting Started

🔖 Prerequisites

JavaScript: version x.y.z

📦 Installation

Build the project from source:

1. Clone the sat-webpage repository:

❯ git clone https://github.com/otaviosouza21/sat-webpage

2. Navigate to the project directory:

❯ cd sat-webpage

3. Install the required dependencies:

❯ npm install

🤖 Usage

To run the project, execute the following command:

❯ node app.js

🧪 Tests

Execute the test suite using the following command:

❯ npm test

---

📌 Project Roadmap

• Task 1: Implement feature one.
• Task 2: Implement feature two.
• Task 3: Implement feature three.

---

🤝 Contributing

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

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

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/otaviosouza21/sat-webpage

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.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

🎗 License

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

---

🙌 Acknowledgments

• List any resources, contributors, inspiration, etc. here.

---