search

rpavlenko / CodersCamp2021-Project3-ExpensesApp-backend

Backend project for ExpensesApp
https://expenses-app-frontend-63b9u.ondigitalocean.app/
0 stars 2 forks source link
coderscamp coderscamp2021 coderscamp2021-dzial-3

readme

Coders Camp 2021 | Project 3 | Node.Js - Server Side Javascript

 

Application Demo

Here you an check demo of our Application: Scrooge App.

 

Table of contents

 

Project Team

The Project was created as a part of CodersCamp initiative by participants of the course, supervised by a mentor. We encourage you to familiarize yourself with team members' profiles and their portfolio:

Mentor: Michał Ciborowski

Participants of Coders Camp course:

 

As a part of the project team members have been assigned to additional roles:  

Name Role in the Project
Barbara Korytkowska Product Owner
Zuzanna Wypych Project Manager
Roman Pavlenko Tech Lead
Michał Ciborowski Client

 

Application

About Project

"Scrooge" is a budget Web application developed with the idea to help potential users make the best decisions with their money. Main purpose of this project is to setup backend for Application created in previous project.

 

Routes

Users

Model:

Parameter Required Type
email required string
password required string
categoriesID optional mongoose.SchemaTypes.ObjectId
isActive required boolean
CreatedAt required date
ModificatedAt optional date

/api/v1/users

Route Method Authentication token needed?
/users/login POST
/users/register POST
/users/verify POST
/users/ PATCH
/users/reset-password POST
/users/reset-password/:id POST

Categories

Model:

Parameter Required Type
user required mongoose.Schema.Types.ObjectId
(Ref to the User)
name required string
limit optional number

/api/v1/categories /api/v1/categories/:id

Route Method Authentication token needed?
/categories/ GET yes
/categories/:id GET yes
/categories/ POST yes
/categories/:id DELETE yes
/categories/:id PATCH yes

Transactions

Model:

Parameter Required Type
userID required mongoose.Schema.Types.ObjectId
(Ref to the User)
category required string
title required string
amount required number
type required string
date required date

/api/v1/users /api/v1/users/:id

Route Method Authentication token needed?
/categories/ GET yes
/categories/:id GET yes
/categories/ POST yes
/categories/ DELETE yes
/categories/:id PATCH yes

Balance

/api/v1/balance

Route Method Authentication token needed?
/balance/ GET yes

Technologies

Technologies used in Project:

Setup

To run this project, install it locally on your machine using npm:

$ cd ../
$ npm install
$ npm start

Application will launch on http://localhost:3000 in your browser.