💻 FullStack Overflow Developer API

For those who like to find someone in the same situation, but also a solution to the problem.

Status: Finished

About • Database • How It Works • Pre-requisites • Tech Stack • How to contribute • Author

About

FullStack Overflow API was designed to facilitate the flow of questions and answers from your group of friends and co-workers in the tech world!

Database

The database was designed at https://www.dbdesigner.net/ for PostgreSQL.


/* In your psql terminal */
CREATE DATABASE fsoverflow;

/* Access the database */
\c fsoverflow

Now, just run the commands listed in dump.sql

How It Works

POST /questions

POST /questions

Expected Body

{
  "question": "How it works?",
  "student": "Bob",
  "classname": "T3",
  "tags": "typescript, lifestyle, javascript, java?"
}

Possible Response Status

400: 'The request body contains invalid elements';
201: 'Created';
404: 'The student name does not belong to any registered user';
404: 'The class name does not belong to any registered class';
500: 'Internal Server Error - error details'

POST /questions/:id

POST /questions/:id

Expected Body

{
  "answer": "Just look at the README file :)" 
}

Possible Response Status

400: 'The request body contains invalid elements';
200: 'OK';
404: 'Question not found';
409: 'Question already answered';
500: 'Internal Server Error - error details'

POST /users

POST /users

Expected Body

{
  "name": "John",
  "classname": "T4" 
}

Possible Response Status

400: 'The request body contains invalid elements';
201: 'Created';
404: 'The class name does not belong to any registered class';
409: 'User already registered';
500: 'Internal Server Error - error details'

GET /questions

GET /questions

Expect to receive

[
  {
    "id": 11,
    "question": "We gonna learn TS?", 
    "student": "Zoru", 
    "class": "T3",
    "submitedAt": "2021-11-20 10:12"
  },
  {
    "id": 15,
    "question": "New here, should I learn JS or Python first?", 
    "student": "Zoru", 
    "class": "T4",
    "submitedAt": "2021-11-19 07:12"
  }
]

Possible Response Status

200: 'OK'
404: 'Unanswered questions not found';
500: 'Internal Server Error - error details'

GET /questions/:id

GET /questions/:id

Expect to receive

// Answered Question
{
  "question": "How It Works?",
  "student": "Bob",
  "class": "T3",
  "tags": "typescript, lifestyle, javascript, java?"
  "answered": true,
  "submitedAt": "2021-11-16 08:35"
  "answeredAt": "2021-11-16 13:30"
  "answeredBy": "Dylan",
  "answer": "Just look at the README file :)" 
}

//Unanswered Question
{
  "question": "We gonna learn TS?", 
  "student": "Zoru", 
  "class": "T3",
  "tags": "typescript, bootcamp",
  "answered": false,
  "submitedAt": "2021-11-20 10:12"
}

Possible Response Status

200: 'OK'
404: 'Question not found';
500: 'Internal Server Error - error details'

Pre-requisites

Before you begin, you will need to have the following tools installed on your machine: Git, Node.js, VSCode.

Running the Backend (server)

// Clone this repository
$ git clone git@github.com:okitauehara/fsoverflow-developer-api.git

// Access the project folder cmd/terminal
$ cd fsoverflow-developer-api

// Install the dependencies
$ npm install

// Create a .env.dev file and fill it using your environment variables following the .env.example

// Run the application in development mode
$ ntl -> start:dev

// The server will start at port: 4000

You can find the .env.example here

Tech Stack

The following tools were used in the construction of the project-api:

Server (NodeJS)

Express
CORS
NTL
Pg
DotENV
Joi
TypeScript
Eslint - Airbnb

See the file package.json

Utilitários

Editor: Visual Studio Code
API Test: Insomnia

How to contribute

Fork the project.
Create a new branch with your changes: git checkout -b feat/myFeatureName
For each feature implemented, make a commit specifying what was done
Submit your changes: git push -u origin feat/myFeatureName

Author

Developed by Marcos Okita Uehara.