Skip to content

Latest commit

 

History

History
87 lines (53 loc) · 3.43 KB

LEARN.md

File metadata and controls

87 lines (53 loc) · 3.43 KB
Raw

Welcome to UniCollab - Where Collaboration Fuels Innovation!

Introduction

UniCollab is not just a platform; it's a community-driven ecosystem that empowers students to showcase their projects, collaborate with peers, and dive deep into the world of innovation. Whether you're looking to share your latest project, explore cutting-edge creations, or simply connect with like-minded individuals, UniCollab is the place to be.

Getting Started

1. Clone the Repository

First, clone the UniCollab repository to your local machine:

git clone https://github.com/SUGAM-ARORA/UniCollab.git

2. Install Dependencies

Navigate to the project directory and install the necessary dependencies:

cd UniCollab
npm install

3. Start the Development Server

Launch the development server and explore UniCollab:

npm start

Open your browser and visit http://localhost:3000 to experience UniCollab firsthand.

4. Test the app

Launch the test runner in the interactive watch mode:

npm test

5. Build the app

Build the app for production to the build folder:

npm build

This command builds the app for production, bundling React in production mode and optimizing the build for the best performance. The build is minified and the filenames include hashes. Your app is now ready to be deployed!

6. Eject the app

If you're not satisfied with the build tool and configuration choices and want full control over them, you can eject at any time:

npm eject

Note: This is a one-way operation. Once you eject, you can't go back. This command will remove the single-build dependency from your project, copying all the configuration files and transitive dependencies (webpack, Babel, ESLint, etc.) right into your project so you have full control over them. All commands except eject will still work, but they will point to the copied scripts so you can tweak them. It's important to note that 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.

Key Features

  • Project Showcase: Upload your projects and browse through a diverse range of creations from fellow students. Like and comment to appreciate and provide feedback.

  • Experience Points: Earn experience points for each project upload and engagement. Climb up the leaderboard and showcase your expertise.

  • Trending Projects: Stay updated with the latest trends in student innovation. Discover projects that are making waves in your field of interest.

How to Contribute

UniCollab thrives on community contributions. Here's how you can get involved:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your feature or bug fix.
  4. Make your changes and test them thoroughly.
  5. Commit your changes and push them to your fork.
  6. Submit a pull request to the main branch of the original repository.

Feedback and Support

Your feedback is invaluable to me as I strive to improve UniCollab. Whether you have suggestions, bug reports, or just want to say hello, feel free to reach out to @SUGAM-ARORA or open an issue on GitHub.

Start your journey with UniCollab today and be part of a vibrant community that celebrates innovation!