larasouzabr / cadastro-de-calouros-1

An API developed with NodeJS.

Cadastro de Calouros

An API developed in NodeJS for the Introduction to Software Engineering class, in order to explain about software testing with a focus on unit tests, integration tests and test coverage.

🎮 Getting started

🔋 Downloading softwares

• NodeJS and NPM: https://nodejs.org/en/
• Yarn (optional): https://yarnpkg.com/getting-started/install
• VS Code: https://code.visualstudio.com
• Insomnia: https://insomnia.rest/download

🧬 Clone this repository

git clone https://github.com/joaogabriel-sg/cadastro-de-calouros.git

📂 Move yourself to the appropriate repository

cd cadastro-de-calouros

🎉 Install the package dependencies

npm install
# or
yarn

🔥 Usage

npm run dev
# or
yarn dev

🧪 Testing

npm test
# or
yarn test

🚚 API

🚚 Routes

GET     /students         Get students
GET     /students/{id}    Get a student
POST    /students         Create a new student
PUT     /students/{id}    Update an existent student
DELETE  /students/{id}    Delete a student

🚚 Student structure

interface Student {
  id: string,
  name: string,
  email: string,
  cep: number,
  address: string,
  number: number,
  neighborhood: string,
  city: string,
  uf: string,
  degree: string,
  age: number,
},