Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ahsannjavaid/un-portal

UN Portal is an educational portal where teachers register students and assign them with their academic record and students see their academic record by logging into their respective accounts. Please refer to README.md file to know more about this project.
https://github.com/ahsannjavaid/un-portal

academia admin crud education instructors students

Last synced: about 1 month ago
JSON representation

UN Portal is an educational portal where teachers register students and assign them with their academic record and students see their academic record by logging into their respective accounts. Please refer to README.md file to know more about this project.

Awesome Lists containing this project

README 

        
# What is UN Portal?



Assalam-u-Alaikum!



UN Portal is basically a student portal where students can see their Academic information (e.g., instructors, subjects enrolled, exams such as quizzes, Assignments, etc's marks).



## Summary/Flow of the Project:



1. The instructor first makes his account if he has not signed up before (otherwise he will simply log in).

2. The instructor will register his students one by one and assign each student a unique student ID.

3. After registering the students, he can post marks of different activities done in class against each student's record.

4. Then students can log in to their accounts through the Student ID and password provided by their instructor.

5. Students can check their received marks in different subjects enrolled by their instructors.



## CRUD Functionality



* Both students and instructors can edit their account info

* Admin authorities are also added (The only admin can delete any instructor)



# Technology Used



MERN Stack



## Client/Frontend



* React.js

* Bootstrap 5



## Server/Backend



* Express.js

* Node.js



## Database



* MongoDB



# Hosting



I have used free services for the hosting of this project.



## Client (Front-end)



The front-end has been hosted on [Netlify](https://www.netlify.com/).



## Server (Back-end)



The back-end has been hosted on [Render](https://www.render.com/).



# Server: Node.js, Express.js and MongoDB



## Available Scripts



First of all install dependencies by typing following command in **back-end** directory:



### `npm install`



In the back-end directory, you can run:



### `npm start`



Runs the server in the development mode at URL [http://localhost:5000](http://localhost:5000).



# Client: Getting Started with Create React App



This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).



## Available Scripts



First of all install dependencies by typing following command in **front-end** directory:



### `npm install`



In the front-end directory, you can run:



### `npm start`



Runs the app in the development mode.\

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.



The page will reload when you make changes.\

You may also see any lint errors in the console.



### `npm test`



Launches the test runner in the interactive watch mode.\

See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.



### `npm run build`



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](https://facebook.github.io/create-react-app/docs/deployment) for more information.



### `npm run eject`



**Note: this is a one-way operation. Once you `eject`, you can't go back!**



If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.



Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.



You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.



## Learn More



You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).



To learn React, check out the [React documentation](https://reactjs.org/).



### Code Splitting



This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)



### Analyzing the Bundle Size



This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)



### Making a Progressive Web App



This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)



### Advanced Configuration



This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)



### Deployment



This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)



### `npm run build` fails to minify



This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)