La Vie Psychology Clinic API

This repository is the third project for the Gama Academy Web Development course, featuring a Web API for a fictional psychology clinic called La Vie.

Objective

Utilize the knowledge acquired in Node.js, Express, and MySQL database to create a Web API for a fictional psychology clinic called La Vie.

La Vie API Documentation (still in refactoring process)

Tech Stack

• JavaScript
• Node.js
• Express
• MySQL

Specifications

This API should allow the creation of:

• Psychologist records
• Patient registrations
• Clinical record entries

Installation

1. Create your own .env file according to example.env
2. Download packages npm i
3. Test server npm run dev

Creating the database

5. npm run dbbuild
6. If necessary, rebuild the DB with npm run dbrebuild

API Endpoints

To access the API endpoints locally:

1. Run server with npm run dev
2. Access URL {host}:{port}/api-docs -> still in the writing process after major refactoring

Equipe

Tiago M. Speckart

Claudia Arai

Matheus Boneli