Mess Management System API

The project provides free API for manage mess.

The API is REST API and uses JWT token for user authentication purposes. Currently, return format for all endpoints is JSON.

You can try our API in Swagger (https://mess-api.herokuapp.com/swagger)

Features

• Registration for new mess

• Add/ delete mess members

• Update and record mess/users balance and expense

• Monthly report Mess/User

Endpoints

Auth Resources

• [POST SignUp]: /api/auth/signup
• [POST Login]: /api/auth/login

User Resources

• [POST AddUser]: /api/v1/user/addUser
• [GET GetUsers]: /api/v1/user/getUsers
• [GET GetProfile]: /api/v1/user/getProfile
• [PUT UpdateProfile]: /api/v1/user/updateProfile
• [PUT ChangePassword]: /api/v1/user/changePassword
• [DELETE RemoveUser]: /api/v1/user/removeUser/:userId

Category Resources

• [POST AddCategory]: /api/v1/category/addCategory
• [GET GetCategory]: /api/v1/category/getCategory
• [PUT UpdateCategory]: /api/v1/category/updateCategory/:categoryId
• [DELETE DeleteCategory]: /api/v1/category/deleteCategory/:categoryId

Balance Resources

• [POST AddBalance]: /api/v1/balance/addBalance
• [GET MessTotalBalance]: /api/v1/balance/messTotalBalance
• [GET UserTotalBalance]: /api/v1/balance/userTotalBalance
• [GET UserMealBalance]: /api/v1/balance/userMealBalance
• [GET CategoryWiseBalance]: /api/v1/balance/categoryWiseBalance/:categoryId
• [GET CurrentBalance]: /api/v1/balance/currentAvailableBalance
• [PUT UpdateBalance]: /api/v1/balance/updateBalance/:balanceId
• [DELETE DeleteBalance]: /api/v1/balance/deleteBalance/:balanceId

Expense resources

• [POST AddExpense]: /api/v1/expense/addExpense
• [PUT updateExpense]: /api/v1/expense/updateExpense/:expenseId
• [GET MessTotalExpense]: /api/v1/expense/messTotalExpense
• [GET MealTotalExpense]: /api/v1/expense/mealTotalExpense
• [GET CategoryWiseExpense]: /api/v1/expense/categoryWiseExpense/:categoryId
• [DELETE DeleteExpense]: /api/v1/expense/deleteExpense/:expenseId

Meal resources

• [POST AddMeal]: /api/v1/meal/addMeal
• [PUT UpdateMeal]: /api/v1/meal/updateMeal/:mealId
• [DELETE DeleteMeal]: /api/v1/meal/deleteMeal/:mealId
• [GET TotalMealInMonthMeal]: /api/v1/meal/totalMealInMonth
• [GET CurrentMeal]: /api/v1/meal/currentMeal
• [GET MealRateInMonth]: /api/v1/meal/mealRateInMonth
• [GET UserWiseMeal]: /api/v1/meal/userWiseMeal/:userId

Mess Resources

• [GET MessSummary]: /api/v1/mess/messSummary
• [GET UserSummary]: /api/v1/mess/userSummary/:userId

Prerequisites

• Install NodeJS.

• Install and connect mongoDB.

After complete installation Node and mongodb.

git clone https://github.com/mirajehossain/mess-management-system.git
cd mess-management-system
npm install
npm start