This is my undergraduate final year project where I was tasked to create an online platform that could acquire and monitor heterogeneous data from IoT sensors or devices. It consists of an express.js server (source code in src/server) that is connected to a mongodb database which handles receiving API post requests from IoT devices, storing the data within the database, and through websockets, communicates with the frontend portal so that users can see changes within their IoT data. Users are able to register, login, create multiple "projects" which will be responsible for each IoT device a user has. Users can also download IoT data for a specific project as a csv.
The project uses the dotenv library in order to get environmental variables, so a .env file should be created with the following variables (Note: the Database urls used must be mongo databases):
What port do you want the server to run on (It should be different from the port React.js uses to run it's development server). Please remember to change the package.json proxy field to match where the serve is ran; This is so that react can communicate with the node server.
This could be "development" or "production" depending on what environment your running it on.
This is the mongodb development server.
This is the mongodb production server. It could be the same value as the DB_URL_DEVELOPMENT but it is required during production.
This is the secret key that will be used by the jsonwebtoken library in order to sign and verify tokens.
- Clone this repository.
- Open a terminal.
- Go to the directory that this project was cloned to with the terminal.
- Type “npm install” in order to download dependencies that are required by this project.
- Type "npm run fixadminbro --force" to fix some dependency issues that occur between this project's react module and the adminbro's react module.
- Type "npm run devserver" to launch a development backend server in the background.
- Type "npm start" to launch development frontend server.
- Type "npm build" to build react.js code.
- Type "npm run prodserver" to launch a production server that uses the build folder from react.js (to see the admin page just type "/admin" after the domain).
- How to use material-ui to create the frontend portal
- How to use socket.io to tell the frontend to update itself when data is sent to the server by an IoT device.
- How to design a database with mongodb to handle storing all the complex data.
- How to use jwt for authentication.
- How to use adminbros to set up an easy to use admin panel.
- Make the UI nicer because I couldn't to long on the look of the web app due to time constraints
- Incorporate Lazy loading: This would help the project load time and only allow chunks of javascript code to be download by the browser at a time. This will make the website way faster.
If you are having trouble running the project please make sure to clear your localStorage then refresh the application in the browser and also make sure the database uri provided is a mongo database or else the application will not run.