mindwebs / snacc-api

Backend API for a mess management software

Project Snacc

A software solution for managing hostel meals and mess.

Contents

1. Description
2. Project structure
3. Getting started
4. Built with
5. Authors

Description

Snacc is being developed by Mangalam Sharma as a part of his training period of learning backend with node ts under Mind Webs Ventures, mentored by Aunomitra Ghosh and Ayush Singh.

This project serves as a software solution for hostels to manage their mess related tasks.

What's the problem?

There is a lack of an online platform for hostel boarders to stay updated about their daily hostel meals as well as to turn their meal off or on for the day. All these tasks are done manually using registers and papers and not very reliable and viable. This project serves to solve the above problem.

How can this project help?

This project will help manage mess related tasks - like maintaining a log of food items being ordered, meals being cooked daily, count number of meals to be cooked by taking input from users whether to turn their meal on or off for the day and some more minor helpful features.

Project structure

/
  ├── build/              build files for typescript (gitignored).
  ├── node_modules/       npm packages (gitignored).
  ├── src/              
    ├── config/           configs for db, swagger and other packages go here
    ├── controllers/      controller functions for every route. controllers make calls to services
    ├── interfaces/       structure for various data objects are defined under this directory
    ├── middlewares/      middlewares for various routes go here
    ├── models/           database schema / models go here
    ├── routes/           routes or endpoint definitions go here, routes make calls to controllers
    ├── services/         files that process and query the database go here 
    ├── app.js              entry point for our project
  ├── .env                environment variables used in the project (gitignored)
  ├── .gitignore          stores files and directories to be ignored in commits
  ├── .prettierrc         configuration for prettier to help maintain a common code formatting
  ├── package.json        metadata of the project
  ├── package-lock.json   stores version of every package used in the project
  └── readme.md           details and instructions about the project go here

Getting started

To run the api locally, follow these steps:

1. clone the repository
2. create the .env file with PORT, CONNECT_URL and JWT_SECRET variables
3. run npm i to install packages defined in package.json
4. run npm run start to start the backend server.

If you make any change to the codebase, run npm run prettify to format the code using the configured prettier npm package.

Prerequisites

1. node and npm
2. typescript
3. postman

Built with

• NodeTS and Express for backend
• MongoDB as the database
• Postman for API Testing

Authors

snacc-api's Issues

Completion of user routes

change password, forgot password and reset password.

look up what logic is generally used in the backend to tackle these three requirements and work on the same.

Password hashing

Never save passwords as they are in the database. Use some npm package like bcrypt or sha256 to hash the password before adding it to the database.

Day wise meal count APIs

Create APIs such that:

• users can view today's meal
• users can individually turn their meal on or off for the day.
• fetch meal count for today (non veg - veg separate counts)
• also store food items ordered for the day's meal and save them in the database along with cost, weight etc.

Modularizing responses

[ To be done after all APIs have been written ]