Kathmandu University Open Source Project (KUOSC) Website

Welcome to the official repository of the Kathmandu University Open Source Project (KUOSC) website! This README serves as a comprehensive guide to understanding the purpose, features, installation instructions, and usage guidelines for the KUOSC website project. Whether you're a potential contributor, user, or simply interested in our project, we're thrilled to have you here.

Table of Contents

• Introduction
• Features
• Before you build this site
  • Prerequisites
  • Installation
• Usage
• Contributing
• Community

Introduction

The Kathmandu University Open Source Project (KUOSC) website aims to provide an open and collaborative platform for showcasing the innovative projects, research, and contributions made by community members. By developing a user-friendly and informative website, we strive to create a space where students, faculty, and alumni can share their work, collaborate on projects, and foster a culture of open-source collaboration.

Features

• Research Highlights: Discover groundbreaking research initiatives undertaken by the university's scholars.
• Event Announcements: Stay updated with upcoming seminars, workshops, and events organized by KUOSC.
• Open Source: The website itself is an open-source project, encouraging collaboration and improvements from the community.
• Developed and Maintained by KUOSC

before-you-build-this-site

Prerequisites

Before you proceed, ensure you have the following prerequisites:

This website is built using Docusaurus a free documentation website generator developed and maintained by Meta Open Source.
Follow the Docusaurus official documentation to setup the development environment to run this project.
Docusaurus Documentation: https://docusaurus.io/docs

Installation

1. Clone the Repository:

git clone https://github.com/kuosc/website.git
cd website

2. Install required packages:

npm install --legacy-peer-deps

3. Run the project:

npm start

Contributing

We welcome contributions from the community to make the KUOSC website even better. To contribute:

1. Fork the repository and create a new branch for your feature or bug fix.
2. Make your changes and commit with descriptive messages.
3. Push your branch to your forked repository.
4. Submit a pull request to the main repository.
5. Please follow our Contribution Guidelines for detailed instructions.

Community

Join our community to stay connected, ask questions, and share your thoughts:
Discord
Twitter
Website
Matrix