Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/isabelle-moura/buscar-medicos

Here's Arnia's Module 2 project.
https://github.com/isabelle-moura/buscar-medicos

axios react react-router-dom styled-components typescript

Last synced: 9 days ago
JSON representation

Here's Arnia's Module 2 project.

Awesome Lists containing this project

README 

        
# Buscar Médicos - Project Documentation



## 🙏 Special Thanks 



👉 Before we start our documentation, *I would like to dedicate this entire project to*:



- **God, Jesus,** and **Blessed Mary**.

  

- My beautiful and wonderful family: **Mom, Nana, Jessie, Grandpa, and Grandma**. I love you guys so badly!

  

- And last but not least, to all of my amazing teachers: **Profº Alberto Timóteo, Profº Lucas Ferreira, Profº Marcos Azevedo (Marcão) and Monitor Jessie Moura**.



### Without you guys, this wouldn't be possible. Thank you!!! 💖💖💖



#  Project Introduction 🚀



***Buscar Médicos*** is an innovative application designed to enhance the experience in the medical sector, by optimizing the connection between doctors and medical service providers.



The application encompasses a range of features, including a login system and six main screens: **Dashboard, Registered Users, Plans, Specialties, Notifications, and FAQ**.



## ◻ Login Screen



The login screen allows users to authenticate themselves within the application. Upon successful login, users are directed to the main dashboard.



## ◻ Dashboard



In this screen, users can:



- View the last 3 users registered in the API.

- Check the number of doctors and service providers on the platform.

- Determine how many doctors and service providers are available or unavailable.



## ◻ Registered Users



In this screen, users can:



- View all existing users in the API.

- Categorize users into doctors and service providers.

- Click on a name in the table to access the complete user details.



## ◻ Plans



In this screen, users can:



- Review available plans, including the period, status (active or inactive), and cost.

- Perform CRUD operations (Create, Read, Update, Delete) to manage plans.



## ◻ Specialties



In this screen, users can:



- Review available medical specialties and their status (active or inactive).

- Conduct CRUD operations to manage specialties.



## ◻ Notifications



In this screen, users can:



- Access all sent notifications.

- Send new notifications.

- Perform CRUD operations to manage notifications.



## ◻ FAQ



In this screen, users can:



- Access a list of frequently asked questions.

- Find essential information through questions and answers.



## ◻ Profile



The profile section allows users to:



- Edit their own profile.

- View all existing profiles.

- Perform CRUD operations to manage profiles.



# Technologies Used

- **Front-end**: Developed in React, an open-source JavaScript library known for its efficiency and scalability in UI development.



- **Programming Language**: Was used TypeScript, a language that adds static typing to JavaScript, providing greater security and productivity to the code.



- **Styling**: The whol interface is crafted with Styled-Components, a library that allows component styling with the flexibility of CSS-in-JS.



## Backend



The project's API was developed by a team of former students from the course. They are awesome, by the way.