Tecnologias | Pré-Requisitos | Documentação | Como executar

🎯 Sobre o projeto

Nosso objetivo é tornar fácil o acesso a criação, publicação e leitura de artigos científicos de qualidade, que sejam aprovados pela comunidade.

🛠️ Tecnologias

⚡ Pré-Requisitos

Você vai precisar ter instalado em sua máquina as seguintes ferramentas:

Documentação

Api Endpoints

Breve descrição dos endpoints da aplicação.

Sessions

Utilizado para logar e obter o token de autenticação

POST /sessions

Articles

Retorna uma lista de artigos

GET /articles

Salva um artigo

POST /articles

Retorna um artigo pelo id

GET /articles/{id}

Atualiza um artigo

PUT /articles/{id}

Deleta um artigo

PUT /articles/{id}

Users

Retorna uma lista de usuários

GET /users

Salva um usuário

POST /users

Retorna um usuário pelo id

GET /users/{id}

Atualiza um usuário

PUT /users/{id}

Deleta um usuário

PUT /users/{id}

Administrators

Altera a função de um usuário

PATCH /administrators/{id}

Proofreaders

Altera o status de um artigo

PATCH /proofreaders/{id}

🚀 Como executar ?

🐳 Execute com o Docker

🚨 Configure as variáveis ambiente alterando o arquivo .env.example para .env

# Clone o repositório
$ git clone https://github.com/pedro-drosa/substance.git

# Inicie os containers

$ docker-compose up

# Agora você pode acessar

$ http://localhost:5000

⚡ Execute sem o Docker

# Clone o repositório
$ git clone https://github.com/pedro-drosa/substance.git

# Instale as dependências
$ npm install

# Inicie o servidor
$ npm run dev

# Você deve ter o Mysql devidamente configurado em sua máquina para continuar...
# Lembre-se de configurar seu usuário e senha!

# Crie a base de dados
$ npx sequelize-cli db:create

# Execute as migrações
$ npx sequelize-cli db:migrate

# Adicione os seeds
$ npx sequelize-cli db:seed:all

# Agora você pode acessar
$ http://localhost:5000

Postman

- Primeiro, importe o arquivos.
- Abra o Postman, clique em `File` -> `Import` -> `File` -> ,`Upload files`.

- Depois de importar o arquivo, clique em `Colections`.

- A partir daqui você consegue testar a nossa API ! Para isso, entre em sessions.

- Coloque as credenciais do usuário e clique em `Send`.

- Com o token gerado no passo anterior, você consegue acessar as APIs.

Clique em Authorization

Cole o token no campo.

- Clique em send e pronto, está rodando 😄 .