/uit-hub

A website for my university where they can put their profile up and connect with each other.

Primary LanguageJavaScript

UIT Student Hub

UIT Student Hub is a web application currently under development, built on the MERN (MongoDB, Express.js, React.js, Node.js) stack. It aims to provide a platform for university students of the Usman Institue of Technology (UIT) to create profiles and connect with other students within the university.

Table of Contents

Features

  • User Registration: Students can create an account and register themselves on the platform.
  • User Profile: Each student can create and manage their profile, including personal information, educational background, skills, and interests.
  • Search and Connect: Students can search for other students within their university based on various criteria such as course, interests, or skills and connect with them.

Installation

To run UIT Student Hub on your local machine, follow these steps:

  1. Clone the repository:
git clone https://github.com/your-username/uit-student-hub.git
  1. Navigate to the project directory:
cd uit-hub
  1. Install the dependencies:
npm install
  1. Create a .env file in the root directory and add the following environment variables
DB_CONNECTION = your-mongodb-connection-string
SECRET_KEY = your-secret-key
  1. Start the development server
npm start
  1. Open your browser and visit http://localhost:3000 to access UIT Student Hub.

Usage

Register an account on UIT Student Hub. Create your profile and fill in the required information. Explore the limited features available in the current development phase. Connect with other students (limited functionality). Provide feedback and report any issues or bugs you encounter.

Contributing

We welcome contributions from the community! If you'd like to contribute to UIT Student Hub, please follow these steps:

Fork the repository. Create a new branch for your feature or bug fix. Make your changes and commit them. Push your changes to your forked repository. Submit a pull request to the main branch of the original repository. Please make sure to follow the code of conduct and the contributing guidelines when contributing.

Happy coding!