Giter Club home page Giter Club logo

sem4-se-project's Introduction

drinksapHe - your maintenance companion


logo


drinksapHe is a project developed during the Software Engineering course. The core functionality of this project is to monitor the pH level of drinking water in various water coolers in the Computer Centre 2 of IIIT Allahabad.

“DrinkSapHe©” aims to improve the efficiency of water cooler maintenance process, starting with water coolers of CC3, and perhaps later expanding to the other water coolers of the campus of IIIT-Allahabad. Real-time reporting of water quality levels will reduce the time it takes to regularly check the quality manually. The in-built reporting feature makes it easier for students to report problems to the maintenance team.

Details

Team Members

Techstack

  • Frontend - ReactJS
  • Backend - NodeJS, ExpressJS
  • Database - MongoDB

Built With

  • VS Code / Atom - for developing.

Backend tools and libraries

  • Postman - for testing the API
  • MongoDB Compass / Robo3T - for visualising the database.
  • Mongoose - for easier modelling of database schemas in MongoDB.
  • bcryptjs - for secure storage of passwords.
  • Nodemailer - for automating the sending of emails.

Frontend tools and libraries

  • create-react-app - for initialising react app.
  • react-bootstrap and bootstrap - for responsive design templates.

How to Use

Installation

Package Dependencies

  • NodeJS
  • NPM
  • MongoDB

Open git bash and navigate to your preferred directory.

git clone https://github.com/sanskar-p/Sem4-SE-Project.git
cd Sem4-SE-Project

Create a second terminal instance and navigate to the above directory.

First instance (backend) -

cd server
npm install
npm start

Second instance (frontend) -

cd client
npm install
npm start

If your default browser does not launch automatically, open a browser tab and navigate to localhost:3000. The Backend API will be running at localhost:8080.

First things first

Create another terminal instance and navigate to the server directory. Now, to initialise the database collection, run the following command:

npm run initDrinksaphe

Next, you're going to have to generate an admin user for yourself.

npm run createAdmin

This command will generate admin credentials in your database. Now you can login using these credentials. The admin user has full access to all functionalities of the app, ranging from creating new users to setting the alert interval.

Setup is complete! (Yay?)

sem4-se-project's People

Contributors

sanskar-p avatar cremento avatar gitikay avatar anshumanbhardwaj1370 avatar dragoon102 avatar

Stargazers

 avatar  avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.