M3-Project-API

The SWOT project was created by two aspiring Web Developers, Matheus Benamor and Thais Fernandes, currently studying at the Ironhack's Bootcamp. Our main goal is to make a platform that helps our clients to plan their business or personal life using swot analysis as a tool to better organize this process. Deploy Link: SWOT APP.

Frontend Repository: Client Repository.

Technologies

• [HTML] - [CSS] - [Javascript] - [React] - [Node] - [Cloudinary] - [MongoDB] - [Axios] - [GIT] - [Heroku]

Public Routes

Authentication routes - Allows the user to create an account in DataBase and log into the app.

Method	Endpoint	Payload	Response	Action
POST	/auth/signup	{ "email": string,"password": string,"name": string }	{ user }	Creates a new user in DB
POST	/auth/login	{ "email": string, "name": string }	{ user,token }	User can access the plataform

Private Routes

User routes - Users can get your informations and also update and change their password or profile image.

Method	Endpoint	Payload	Response	Action
GET	/user/:userId	-	{ user }	Get a user from DB
PUT	/user/:userId	{ password: { type: String, required: true }, newPassword: { type: String, required: true }	{ user,token }	User udpate your password
PUT	/user/:userId	{ { "image": image } }	{ user,token }	User can update your profile image

Analysis routes - Allow users to create new analysis, update or delete them.

Method	Endpoint	Payload	Response	Action
GET	/analysis	-	[analysis]	Get all user analysis from DB
POST	/analysis	{ "email": string, "name": string }	{ user,token }	User can create a new analysis
PUT	/analysis/:analysisId	{ "email": string, "name": string }	{ user,token }	User can update an analysis
DELETE	/analysis/delete	{ "email": string, "name": string }	{ user,token }	Delete analysis

Feedback routes - Depending on the analysis results, the application will return a feedback based on the analysis risks.

Method	Endpoint	Payload	Response	Action
GET	/feedbacks	-	[feedbacks]	Get the feedback answers based on user's analysis score.