Skip to content

acesknust/cbet-resource-hub-frontend

Repository files navigation

CBET RESOURCE HUB

This project aims to create a centralized, user-friendly online platform that provides a wealth of resources for students, faculty, and anyone interested in engineering at CBET.

Key Features:

  • Curated Resources: Access a comprehensive collection of learning materials, tutorials, project ideas, career guidance, and more, all categorized for easy navigation.
  • Community Contributions: Anyone can contribute valuable resources through a user-friendly submission process, fostering collaboration and growth.
  • Search Functionality: Quickly find what you need with a powerful search bar that filters across various categories of resources.

Tech Stack:

Getting Started (Frontend Development):

  1. Prerequisites:
  2. Clone the Repository:
    git clone https://github.com/acesknust/cbet-resource-hub-frontend.git
  3. Install Dependencies:
    cd cbet-resource-hub-frontend
    npm install
  4. Development Server:
    npm start

This typically starts a development server at http://localhost:3000/ (port might vary).

Contributing:

We welcome contributions from everyone! Here's how you can get involved:

  1. Submit New Resources: Share valuable learning materials, tutorials, project ideas, or career guidance. We'll review and add them to the platform (details on submission process to be added).
  2. Improve Existing Content: Help us maintain accurate and up-to-date information by suggesting edits or corrections.
  3. Feature Requests: Have ideas for additional features? Create an issue on the project's GitHub repository to discuss them.
  4. Code Improvement: Help us improve the codebase by fixing bugs, refactoring code, or adding unit tests.

Code Style and Best Practices:

  • Use descriptive and meaningful variable names (e.g., userFullName instead of uFN).
  • Employ consistent indentation (usually 2 spaces) and formatting.
  • Write clean and readable code with well-organized comments where necessary.

Pull Requests:

  1. Fork the repository: Create your own fork of this repository on GitHub.
  2. Clone your fork locally: Clone your forked repository to your local machine.
  3. Create a new branch: Create a new branch for your feature or fix.
  4. Make your changes: Make your changes to the code.
  5. Commit your changes: Commit your changes with descriptive commit messages.
  6. Push your changes: Push your changes to your forked repository branch.
  7. Create a pull request: Create a pull request from your forked branch to the main branch of the upstream repository.

About

No description, website, or topics provided.

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •