CS Resources Hub

Welcome to CS Resources Hub! This project is a comprehensive web application designed to provide high-quality resources for computer science topics, including algorithms, web development, machine learning, cybersecurity, mobile development, and cloud computing.

Table of Contents

• CS Resources Hub
  • Table of Contents
  • Project Overview
  • Features
  • Getting Started
    • Prerequisites
    • Installation
  • Running the Project
  • Project Structure
  • Content Management
    • Adding New Resources
    • Updating Existing Content
  • Contributing
    • Code Contributions
    • Our Contributors
    • Content Contributions
  • Styling Guidelines
  • Code of Conduct
  • License

---

Project Overview

CS Resources Hub is built using Next.js, Tailwindcss, and MDX. It aims to be a one-stop platform for computer science enthusiasts, students, and professionals to access curated learning materials, tutorials, and resources across various CS domains.

Features

• Comprehensive coverage of CS topics, including Frontend, Backend, and DevOps
• Interactive UI with animated components like TypewriterEffect and AnimatedTitle
• Responsive design for seamless use on different devices
• MDX-based content for easy writing and maintenance
• Search functionality for quick resource access
• Nested routing structure for organized content presentation
• Dark mode support for comfortable reading in different lighting conditions

---

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v17.0.0 or later)
• npm (v6.0.0 or later)
• Git

Installation

1. Clone the repository:

   git clone https://github.com/programming-for-career/cs-resources.git

2. Navigate to the project directory:

   cd cs-resources

3. Install dependencies:

   npm install

---

Running the Project

To run the development server, use the following command:

npm run dev

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

---

Project Structure

cs-resources/
📦cs-resources
 ┣ 📂public
 ┃ ┗ 📜favicon.jpg
 ┣ 📂src
 ┃ ┣ 📂components
 ┃ ┣ 📂pages
 ┃ ┃ ┣ 📂resources
 ┃ ┃ ┃ ┣ 📂algorithms
 ┃ ┃ ┃ ┃ ┗ 📜introduction.mdx
 ┃ ┃ ┃ ┣ 📜algorithms.mdx
 ┃ ┃ ┃ ┣ 📜cloud-computing.mdx
 ┃ ┃ ┃ ┣ 📜cybersecurity.mdx
 ┃ ┃ ┃ ┣ 📜machine-learning.mdx
 ┃ ┃ ┃ ┣ 📜mobile-development.mdx
 ┃ ┃ ┃ ┗ 📜web-development.mdx
 ┃ ┃ ┣ 📜404.mdx
 ┃ ┃ ┣ 📜_app.mdx
 ┃ ┃ ┣ 📜_meta.json
 ┃ ┃ ┣ 📜about.mdx
 ┃ ┃ ┗ 📜index.mdx
 ┃ ┣ 📂styles
 ┃ ┃ ┗ 📜globals.css
 ┃ ┣ 📂types
 ┃ ┃ ┗ 📜environment.d.ts
 ┃ ┗ 📜utils.tsx
 ┣ 📜.eslintrc.json
 ┣ 📜.gitignore
 ┣ 📜.prettierignore
 ┣ 📜next-env.d.ts
 ┣ 📜next-sitemap.config.js
 ┣ 📜next.config.js
 ┣ 📜package-lock.json
 ┣ 📜package.json
 ┣ 📜postcss.config.js
 ┣ 📜tailwind.config.ts
 ┣ 📜theme.config.tsx
 ┗ 📜tsconfig.json

---

Content Management

Adding New Resources

1. Add a new MDX file to the appropriate directory in the resources/ folder.
2. Include the necessary metadata (e.g., title, description, tags) in the MDX frontmatter.
3. Write the content using Markdown and React components.
4. Don't upload images directly to the repository. Instead, host them externally and link to them in the content.

Updating Existing Content

1. Locate the MDX file for the content you want to update.
2. Edit the file as needed and save your changes.

---

Contributing

We welcome contributions! Please follow the guidelines below.

Code Contributions

1. Fork the repository.

2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Commit your changes:

   git commit -m "Add your message here"

4. Push to your branch:

   git push origin feature/your-feature-name

5. Create a pull request.

Our Contributors

View All Contributors? Click Here

Content Contributions

• Submit suggestions for new topics or improvements via GitHub issues.
• If adding content, follow the Content Management guidelines.

---

Styling Guidelines

• Follow the Tailwindcss utility-first approach for styling.
• Ensure responsiveness by testing across multiple devices.

---

Code of Conduct

Please read the Code of Conduct to understand expected behavior.

---

License

This project is licensed under the MIT License. See the LICENSE file for details.