Biust Insight Project

---

What is this project about ❓❓

The Biust Insight Project is primarily an early stage interactive library and data archive. Currently, not much is implemented, however, (almost) everything inside this repository is being created with the assistance of a variety of students in the Community.

Getting Started

Requirements

• node
• git

Downloading the repository:

Start by cloning the repository with

git clone --recursive https://github.com/the-dezeray/biust-insight-project

Install Dependencies:

cd biust-insight-project
npm install

Run the Development Server:

npm run start

The site will be available at http://localhost:3000.

Build the project

npm run build

The Plan 📜

The plan is to architect a modern and better existing Library system.

1. Comprehensive Coverage: Develop a complete and well-organized repository of materials relevant to our field. This includes research papers, case studies, historical documents, and other valuable resources.
2. User Experience: Ensure a seamless and intuitive experience for users, including easy navigation, efficient search capabilities, and responsive design.
3. Quality and Accuracy: Maintain high standards for content accuracy and relevance, ensuring that all materials are thoroughly vetted and up-to-date.
4. Community Engagement: Foster an active community of users and contributors who can provide feedback, contribute content, and participate in discussions.

Main features to come 🚩:

• 🔎Search Functionality: Locate any object in the archive.
• 📂API Integration: Fast smooth interactive animation.
• ✍Blog Support: Blogging.
• 📷Photo Gallery: A photo gallery of pictures taken in BIUST.
• 📰News Section: A section for all current events happening on campus.
• 📦Projects: A list of all projects in progress and completed.

Short term goals 🚩:

• Content Collection: Add more material to the existing structure.
• Stable Foundation: Have a stable foundation and build.
• 🌥Animations: Introduction of dynamic elements to add life to the static feel of the webpage.
• 📗Documentation: A beginner-friendly documentation to the community on how to contribute, including videos for writers and journals.

Version 3 Updates

As of now, V3 has a number of breaking changes:

• Authentication has been removed.
• Upgraded to Docusaurus 3.7.
• Using React 17.
• Compatible with Tailwind CSS.

Development Workflow

1. Create a new branch with the tag feature or hotfix.
2. Make sure to create a new branch for any changes.
3. Do not push to main.
4. All changes will be merged to deployment and then main as the feature branch.