Skip to content

nurislam-ab/sustainability

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

440 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sustainable Products Platform - Software Development Project

Manufacturing companies have the goal of offering CO2-neutral products in the future, but there is a lack of transparency and expertise regarding the use of sustainable materials and optimized logistic processes. We are a Munich-based startup, supporting manufacturing companies in calculating the CO2-emissions of a product (the so-called Product Carbon Footprint) and providing transparency of their current greenhouse gas emissions. Based on this project, we aim to enable manufacturing companies to design sustainable products (EcoDesign) with our software.

Objectives

  • Develop an intelligent EcoDesign Recommendation Algorithm
  • Generate insights into the CO2-impact hotspots of a product (materials, components)
  • Create scenarios of a product design: change and replace materials and components and get direct insight in the impact on potential greenhouse gas emissions
  • Validate the platform with Telusio customers

Scope

The result of the project is an end-user friendly cloud-based platform. Based on CO2 data from our customers and the intelligent recommendation algorithm the platform automatically visualizes the CO2 emissions, shows possible hot spots and carbon reduction potentials. As a user I can perform scenario analyses regarding the replacement of materials and components and comparison of production costs and CO2 emissions for local production versus abroad.

Live Demo

Link

Screenshots

Homepage Dashboard Charts Auth page

Built With

  • React.js
  • Redux
  • Webpack
  • HTML5
  • CSS3
  • Javascript ES6
  • Stylint
  • MongoDB
  • Node.js
  • Express.js

API endpoints

Request type Route Functionality
POST /signup Sign up user
POST /login Login user
POST /somerecords Add somerecords
GET /somerecords Some records list
GET /users/:id View user profile
GET /somerecords/:id (or slug) View some record

Code Organisation

Branches

  • dev branch: all the commits should be done into this branch during the sprint. After testing all of the features developed and the state of previously implemented features, the PR should be sent to the main branch
  • main branch: main production branch.

Commit organisation

  • Please try to follow commit convention, it could help better to track what is every commit about and to organise the work
  • Please try to make only one responsibility for each commit, meaning, it shouldn't be a commit with several features or multiple fixes not related to each other
  • Please write meaningful commits so that everyone could understand what has been done at this commit

Quick instructions on the convention:

  • feat: introduces a new feature, e.g.:
feat: Authentication - Developed user authentication via email
  • fix: patches a bug in the codebase, e.g.:
fix: Authentication - Fixed user authentication via email
  • docs: changes in the doc files, e.g.:
docs: README - Corrected spelling of README
  • style: implementations and changes in the style, e.g.:
style: Authentication - Implemented styles for the User Authentication form
  • refactor: code and performance optimisation changes, e.g.:
refactor: Authentication - Reimplemented UserAuthentication component making it an independent component in a separate file
refactor: Authentication: Login - Added rate limiting for login attempts to mitigate brute force attacks

Database

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • To install the app in your system, make sure you have node/npm installed. get npm

Setup

  • Clone the repository in your system by using following command:

git clone https://github.com/nurislam-ab/ecodesign.git

Install

  • Next step is to CD into the cloned local repository and then CD into the "client" and "server" folders separately and run this command:

npm install

Run the app locally

Start development mode in your local environment

  • Backend

cd server
npm start

  • Frontend

cd client
npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Build the app for production


`npm build`

This command builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Authors

👩‍💻 Yutzu Chen

👨‍💻 Anton Peters

👨‍💻 Felix Bohlen

👨‍💻 Michael Mauẞ

👨‍💻 Nurislam Abdurasulov

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • LMU MMT
  • Telusio

📝 License


About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages