gif

Repo Provas

Helping you with that important upcoming exam!
Explore the docs »
View Demo

Technologies

The following tools and frameworks were used in the construction of the project:

About

This API was made to help students study for upcoming tests. In it, you can contribute by adding an old exam you have from a specific teacher of a specific subject making it public to others. In addition to sending tests, one can also look for them in our database, searching by teacher or subject.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
npm install npm@latest -g

Installation

  1. Create a root project folder named repoprovas for semantics
mkdir repoprovas
  1. Clone the front-end repo (within the /repoprovas folder)
git clone https://github.com/leandrodcs/repo-provas-front.git
  1. Install NPM packages for the front-end repo
npm install
  1. Clone the back-end repo (within the /repoprovas folder)
git clone https://github.com/leandrodcs/repo-provas-back.git
  1. Install NPM packages for the back-end repo
npm install
  1. Create a database using the command below
CREATE DATABASE repoprovas
  1. Inside the created database, create tables using the dump included in the back-end repo here.

  2. Connect to the created database using the .env.example included in the back-end repo here, to make it easy, name your .env file like so ".env.dev".

Running

  1. On the back-end repo run the server connected to the database you just created using the following command.
npm run dev
  1. Now on the fron-end repo use the same command you just used on step 8 and you should be good.

Usage

Visitors can get or post exams at will. The website is self-explanatory, so if you're having any doubts about the usage, you can check out the gif in the beginning of this file to see it in action.

Developer