Skip to content
API em ExpressJS que servirá de backend para o sistema UFERSA Vai de Bike
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
bin
db
routes
tests
.env-example
.eslintrc.json
.gitignore
.travis.yml
README.md
UFERSA Vai de Bike API.postman_collection.json
app.js
package-lock.json
package.json
response.js

README.md

[Português]

ufersavdbAPI Build Status

Aplicação Javascript que utiliza NodeJs e ExpressJs. Serve de backend para o projeto e para o sistema de bicicletas compartilhadas "UFERSA Vai de Bike."

Contribuindo

Ao contribuir com este repositório pedimos a gentileza de discutir primeiro a mudança que você deseja fazer via issue, e-mail ou qualquer outro método com os proprietários deste repositório antes de fazer uma alteração.

Note que temos um código de conduta. Por favor, siga-o em todas as suas interações com o projeto.

Código de Conduta

Nosso compromisso

No interesse de promover um ambiente aberto e acolhedor, nós, como colaboradores e mantenedores, comprometemo-nos a tornar a participação em nosso projeto e em nossa comunidade uma experiência livre de assédio para todos, independentemente da idade, tamanho do corpo, deficiência, etnia, identidade e expressão de gênero, nível de experiência, nacionalidade, aparência pessoal, raça, religião ou identidade e orientação sexual.

Nossos padrões

Exemplos de comportamento que contribuem para criar um ambiente positivo incluem:

  • A utilização de linguagem acolhedora e inclusiva;
  • O respeito com pontos de vista e experiências diferentes;
  • A receptividade em relação às críticas construtivas;
  • O foco no que é melhor para a comunidade;
  • A empatia para com outros membros da comunidade.

Exemplos de comportamento inaceitável pelos participantes incluem:

  • A utilização de linguagem ou imagens sexualizadas e atenção sexual indesejada ou avanços;
  • Trolling, insultos e/ou comentários depreciativos e ataques pessoais ou políticos;
  • O assédio público ou privado;
  • A publicação de informações privadas de outras pessoas, como endereço físico ou eletrônico, sem permissão explícita;
  • Outra conduta que poderia razoavelmente ser considerada inadequada em um ambiente profissional.

Nossas Responsabilidades

Os mantenedores do projeto são responsáveis por esclarecer os padrões de comportamento aceitável e devem tomar as medidas corretivas apropriadas e justas em resposta a quaisquer casos de comportamento inaceitável.

Além disso, têm o direito e a responsabilidade de remover, editar ou rejeitar comentários, commits, códigos, edições do wiki, questões e outras contribuições que não estejam alinhadas a este Código de Conduta, ou banir temporariamente ou permanentemente qualquer colaborador por outros comportamentos que julgarem inapropriado, ameaçador, ofensivo ou prejudicial.

Escopo

Este Código de Conduta se aplica, tanto nos espaços do projeto, quanto nos espaços públicos em que um indivíduo está representando o projeto ou sua comunidade. Exemplos de representação de um projeto ou comunidade incluem o uso de um endereço de e-mail oficial do projeto, postagem por meio de uma conta oficial de mídia social ou a atuação como um representante nomeado em um evento on-line ou off-line. A representação de um projeto pode ser definida e esclarecida pelos mantenedores do projeto.

Aplicação

Instâncias de comportamento abusivo, ofensivo ou inaceitável podem ser relatadas entrando em contato com a equipe do projeto em ufersavaidebike@gmail.com. Todas as reclamações serão analisadas e investigadas e resultarão em uma resposta considerada necessária e apropriada às circunstâncias. A equipe do projeto é obrigada a manter a confidencialidade em relação ao relator de um incidente. Mais detalhes sobre políticas específicas de execução podem ser postados separadamente.

Os mantenedores do projeto que não seguem ou aplicam o Código de Conduta de boa fé podem enfrentar repercussões temporárias ou permanentes, conforme determinado por outros membros da liderança do projeto.

Atribuição

Este Código de Conduta é adaptado do Pacto do Colaborador, versão 1.4, disponível em http://contributor-covenant.org/version/1/4

Documentação

Este projeto utiliza Swagger para gerar a sua documentação e também como ferramenta de auxílio para utilização dos endpoints. A interface do Swagger está disponível em http://localhost:3000/api-docs

Iniciando o Projeto

Para iniciar o projeto, basta definir um arquivo .env na pasta raíz, semelhante ao arquivo .env-example. Contendo as variáveis para conexão ao banco da aplicação, etc.

Em seguida basta rodar o comando npm start. Caso prefira se basear no .env-example basta rodar um npm run copy-env.

Requisitos

Requisitos

npm version:

node version:

nodemon version: 1.19.3

Referências

Designing a RESTful API with Node and Postgres


[English]

ufersavdbAPI Build Status

Javascript application that uses NodeJs and ExpressJs. It serves as a backend for the project and the "UFERSA Vai de Bike" shared bike system.

Contributing

By contributing to this repository we kindly discuss first the change you wish to make via issue, email or any other method with the owners of this repository before making a change.

Note that we have a Code of Conduct. Please follow it in all your interactions with the project.

Code of Conduct

Our compromise

In the interest of spreading an open and welcoming environment, we, as contributors and maintainers, commit ourselves to making participation in our project and our community a harassment-free experience for everyone regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion or identity and sexual orientation.

Our Standards

Examples of behavior that contribute to creating a positive environment include:

  • The use of welcoming and inclusive language;
  • Respect with different points of view and experiences;
  • Responsiveness to constructive criticism;
  • Focus on what is best for the community;
  • Empathy with other community members.

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or images and unwanted sexual attention or advances;
  • Trolling, insults and / or derogatory comments and personal or political attacks;
  • Public or private harassment;
  • The posting of other people's private information, such as physical or electronic address, without explicit permission;
  • Other conduct that could reasonably be considered inappropriate in a professional setting.

Our Responsibilities

Project maintainers are responsible for clarifying standards of acceptable behavior and should take appropriate and fair corrective action in response to any cases of unacceptable behavior.

In addition, they have the right and responsibility to remove, edit or reject comments, commits, codes, wiki edits, questions and other contributions that are not in line with this Code of Conduct, or to temporarily or permanently ban any contributor for other behaviors that deem inappropriate, threatening, offensive or harmful.

Scope

This Code of Conduct applies in both project spaces and public spaces where an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting through an official social media account, or acting as a nominated representative at an online or offline event. The representation of a project can be defined and clarified by the project maintainers.

Application

Instances of abusive, offensive or unacceptable behavior can be reported by contacting the project team at ufersavaidebike@gmail.com. All complaints will be reviewed and investigated and will result in a response deemed necessary and appropriate to the circumstances. The project team is required to maintain confidentiality with respect to the rapporteur of an incident. More details on specific execution policies can be posted separately.

Project maintainers who do not follow or apply the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project leadership.

Assignment

This Code of Conduct is adapted to the Employee Pact, version 1.4, available at http://contributor-covenant.org/version/1/4

Documentation

This project uses Swagger to generate your password and also as a terminal aid tool. A Swagger interface is available at http: // localhost: 3000 / api-docs

Starting the Project

To start the project, simply set a .env file in the root folder, similar to the .env-example .; containing the variables to connect to the application database, etc.

Then just run the npm start command. If you prefer to rely on .env-example just run a npm run copy-env.

Requirements

npm version: node version: nodemon version: 1.19.3

References

[Creating a Node and Postgres RESTful API] (https://mherman.org/blog/designing-a-restful-api-with-node-and-postgres/)

You can’t perform that action at this time.