RepoProvas API, a system for sharing tests between students, built with Typescript, Node.js, Express, Prisma and Postgres.

Lucas Lima

Last update: Dec 13, 2022

Related tags

Learning resource projeto20-repoprovas

Overview

Repoprovas

Built With

📋 Description

RepoProvas API, a system for sharing tests between students, built with Typescript, Node.js, Express, Prisma and Postgres.

💻 Features

Register a new user;
Login a user;
Add a new test;
View tests by disciplines;
View tests by teachers.

🚀 Routes

Register a new user

POST /signup

Request:

Body	Type	Description
`email`	`string`	Required. User mail.
`password`	`string`	Required. User password.
`repeatPassword`	`string`	Required. Repeat user password.

Login a user

POST /signin

Request:

Body	Type	Description
`email`	`string`	Required. User mail.
`password`	`string`	Required. User password.

Response:

{
  "token": 11111111111
}

Add a new test

POST /tests

Request:

Headers	Type	Description
`Authorization`	`string`	Required. User token.

The Authorization field must have the following format: Bearer ${token}

Body	Type	Description
`name`	`string`	Required. Test name.
`pdfUrl`	`string`	Required. Valid pdf url.
`categoryName`	`string`	Required. Category name.
`disciplineName`	`string`	Required. Discipline name.
`teacherName`	`string`	Required. Teacher name.

View tests by discipline

GET /tests/disciplines

Request:

Headers	Type	Description
`Authorization`	`string`	Required. User token.

The Authorization field must have the following format: Bearer ${token}

Response

[
  {
    "id": 1,
    "number": 1,
    "disciplines": [
      {
        "id": 1,
        "name": "Discipline name",
        "categories": [
          {
            "id": 1,
            "name": "Category name",
            "tests": [
              {
                "id": 1,
                "name": "Test name",
                "pdfUrl": "https://...",
                "teacher": {
                  "id": 1,
                  "name": "Teacher name",
                }
              }
            ]
          }
        ]
      }
    ]
  },
  {
    ...
  }
]

View tests by teacher

GET /tests/teachers

Request:

Headers	Type	Description
`Authorization`	`string`	Required. User token.

The Authorization field must have the following format: Bearer ${token}

Response

[
  {
    "id": 1,
    "name": "Teacher name",
    "categories": [
      {
        "id": 1,
        "name": "Category name",
        "tests": [
          {
            "id": 1,
            "name": "Test name",
            "pdfUrl": "https://...",
            "discipline": {
                "id": 1,
                "name": "Discipline name",
            }
          }
        ]
      }
    ]
  },
  {
    ...
  }
]

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

PORT = number Recommended:5000

DATABASE_URL = postgres://UserName:Password@Hostname:5432/DatabaseName

JWT_SECRET = any string

🏁 Run Locally

Clone the project

  git clone https://github.com/lugablima/projeto20-repoprovas

Go to the project directory

  cd projeto20-repoprovas/

Install dependencies

  npm install

Start the server

  npm run dev

The API deploy link is: https://back-projeto20-repoprovas.herokuapp.com/

The Frontend of Escobar's Inventory Management System, Employee Management System, Ordering System, and Income & Expense System

Usage Create an App # with npx $ npx create-nextron-app my-app --example with-javascript # with yarn $ yarn create nextron-app my-app --example with-

Jan 2, 2023

SAP Community Code Challenge: This repository contains an empty OpenUI5 application and end-to-end tests written with wdi5. Take part in the challenge and develop an app that passes the tests.

SAP Community Code Challenge - UI5 The change log describes notable changes in this package. Description This repository is the starting point for the

Oct 24, 2022

Projeto 20° da Driven Education - RepoProvas (front)

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

Sep 26, 2022

Projeto 20° da Driven Education - RepoProvas (Back)

RepoProvas 20th Project of Driven Education An API to manage and storage yout tests Built With Project Guide Features Auth (sign-in/sign-up) Create te

Sep 26, 2022

In this exercise, I will write a few practical tests for JavaScript functions using the Jest library. I will make sure to follow the AAA pattern to make my tests easier for other developers to read and understand. I will also try to use the TDD approach in practice.

Testing Practices To get a local copy up and running follow these simple example steps. (NPM) Ope your terminal Navigate to the directory where you wa

Dec 20, 2022

Comments

Feat tests
Implementei a rota POST '/tests' para adicionar uma prova;

Implementei a rota GET '/tests/disciplines' para buscar todos os testes agrupados por disciplina;

Implementei a rota GET '/tests/teachers' para buscar todos os testes agrupados por professor.
opened by lugablima 0
Feat authentication
Implementei a rota POST /signup para cadastrar um novo usuário;

Implementei a rota POST /signin para logar um usuário;

Implementei os testes de integração da rota POST /signup;

Implementei os testes de integração da rota POST /signin.
opened by lugablima 0