CSCI 4177 Group-22

DalCSHub is a platform for students, instructors, and alumni to come together and share their learning experiences with one another. The platform is written in ReactJS framework along with the MaterialUI library.

• Date Created: 22 May 2023
• Last Modification Date: 11 Aug 2023
• Host URL: https://csci4177-dalcshub.netlify.app/
• API Host URL: https://csci4177-dalcshub-api.onrender.com/
• Group Repository: https://git.cs.dal.ca/chew/4177-group-22

Authors

• Shiwen(Lareina) Yang - (Developer)
• Vrund Patel - (Developer)
• Kent Chew - (Developer)
• Khaled Al-Mahbashi - (Developer)
• Meet Kumar Patel - (Developer)

Instructions

Please follow the following instructions to start the application locally:

API Server

1. Open a command line interface and navigate to the dalcshub-api directory.
2. Run "npm install" to ensure that npm is up to date.
3. Run "npm start" to start the API server.
4. Use http://localhost:8080/ on browser/Postman
5. Alternatively, you may use the hosted API url above.

React Application

1. Open a command line interface and navigate to the dalcshub-react directory.
2. Create a .evn file:

REACT_APP_API_URL=https://csci4177-dalcshub-api.onrender.com
# REACT_APP_API_URL=http://localhost:8080

3. Run "npm install" to ensure that npm is up to date.
4. Run "npm start" to start the React application.
5. Access the application via http://localhost:3000 (default address, may differ for different setups).

Alternatively, you can access the application via its live deployment link listed at the top of this document.

Assets

1. Mail icon, [Online]. Available: https://illustoon.com/?id=2752 [Accessed: Jun-2023].

2. Call icon, [Online]. Available: https://www.pngmart.com/image/518501 [Accessed: Jun-2023].

3. Course Background Images, [Online]. Available: https://github.com/wrappixel/materialpro-react-lite/tree/master/package/src/assets/images/bg [Accessed: Jun-2023].

4. Default Course Background Image, [Online]. Available: https://www.buytvinternetphone.com/blog/images/programming-the-rca-universal-remote-without-a-code-search-button.jpg [Accessed: 26-Jul-2023].

5. High-speed photography of blue ink diffusion in water - pexels [Online]. Available: https://www.pexels.com/video/high-speed-photography-of-blue-ink-diffusion-in-water-9669109/ [Accessed: 20-Jun-2023].

6. Freeiconspng.com “White Down Arrow PNG Transparent Background, Free Download #41944 - FreeIconsPNG,” [Online]. Available: https://www.freeiconspng.com/img/41944 [Accessed: 20-Jun-2023].

References and Acknowledgements

1. Material UI [Online]. Available: https://mui.com/ [Accessed: May-2023].

2. Dalhousie CS Course Descriptions [Online]. Available: https://academiccalendar.dal.ca/Catalog/ViewCatalog.aspx?pageid=viewcatalog&catalogid=105&chapterid=6392&topicgroupid=27853&loaduseredits=False [Accessed: 20-Jun-2023].

3. AppBar from Material UI, The starter code of './src/components/NavBar.js'. [Online]. Available: https://mui.com/material-ui/react-app-bar/ [Accessed: 20-Jun-2023].

4. React Documentation [Online]. Available: https://legacy.reactjs.org/docs/getting-started.html [Accessed: May-2023].