Skip to content

stiantha/DevTools

Repository files navigation

DevTools⚙️

Skjermbilde

📒 Index

Progress

Backend

  • Set up Express.js server
  • Create RESTful API endpoints
  • Set up MongoDB database
  • Structure and add data to MongoDB
  • Add error handling middleware

Frontend

  • Set up React components
  • Integrate with backend APIs
  • Implement client-side form validation

Documentation

  • Write detailed README.md

Additional Features

  • Implement search functionality

🔰 About

Collection of resources for developers.

  • Features
    • Markdown Format
    • Search Functionality
    • Resource Submission
    • Dark Mode

🔧 Development

💻 Tech

  • MongoDB
  • Express.js
  • React.js
  • Node.js

📓 Pre-Requisites

  • Node.js

📁 File Structure

The basic file structure for the project is as follows:

📦DevTools
┣ 📂client‍‍‍‍‍‍‍‍‍‍
┃ ┣ 📂public
┃ ┃ ┣ 📜corrections.css
┃ ┃ ┣ 📜favicon.ico
┃ ┃ ┣ 📜favicon.png
┃ ┃ ┣ 📜index.html
┃ ┃ ┣ 📜manifest.json
┃ ┃ ┣ 📜robots.txt
┃ ┃ ┗ 📜tips.txt
┃ ┣ 📂src
┃ ┃ ┣ 📂app
┃ ┃ ┃ ┣ 📂components
┃ ┃ ┃ ┃ ┣ 📜globals.d.ts
┃ ┃ ┃ ┃ ┣ 📜MDContainer.tsx
┃ ┃ ┃ ┃ ┗ 📜particles.tsx
┃ ┃ ┃ ┣ 📂hooks
┃ ┃ ┃ ┃ ┗ 📜usePageTracking.tsx
┃ ┃ ┃ ┣ 📂layout
┃ ┃ ┃ ┃ ┣ 📜App.tsx
┃ ┃ ┃ ┃ ┣ 📜AppButtons.tsx
┃ ┃ ┃ ┃ ┣ 📜AppTree.tsx
┃ ┃ ┃ ┃ ┣ 📜CategoryContext.tsx
┃ ┃ ┃ ┃ ┣ 📜Footer.tsx
┃ ┃ ┃ ┃ ┗ 📜Sidebar.tsx
┃ ┃ ┃ ┗ 📂pages
┃ ┃ ┃   ┣ 📜aceTheme.js
┃ ┃ ┃   ┣ 📜Admin.tsx
┃ ┃ ┃   ┣ 📜Category.tsx
┃ ┃ ┃   ┣ 📜Home.tsx
┃ ┃ ┃   ┣ 📜links.tsx
┃ ┃ ┃   ┗ 📜pages.ts
┃ ┃ ┣ 📂static
┃ ┃ ┃ ┣ 📜devicons.svg
┃ ┃ ┃ ┣ 📜favicon.png
┃ ┃ ┃ ┗ 📜logo.svg
┃ ┃ ┣ 📜declarations.d.ts
┃ ┃ ┣ 📜index.tsx
┃ ┃ ┣ 📜logo.svg
┃ ┃ ┣ 📜react-app-env.d.ts
┃ ┃ ┣ 📜react-markdown-it.d.ts
┃ ┃ ┣ 📜reportWebVitals.ts
┃ ┃ ┗ 📜setupTests.ts
┃ ┣ 📜.env.development
┃ ┣ 📜.env.production
┃ ┣ 📜.gitignore
┃ ┣ 📜package.json
┃ ┗ 📜tsconfig.json
┣ 📂server
┃ ┣ 📂controllers
┃ ┃ ┗ 📜resourceController.js
┃ ┣ 📂helpers
┃ ┃ ┗ 📜openBrowser.js
┃ ┣ 📂models
┃ ┃ ┗ 📜resourceModel.js
┃ ┣ 📂routes
┃ ┃ ┗ 📜resourceRoutes.js
┃ ┣ 📜.env
┃ ┣ 📜.gitignore
┃ ┣ 📜package.json
┃ ┗ 📜server.js
┣ 📜.gitignore
┣ 📜LICENSE
┣ 📜package.json
┣ 📜project_structure
┣ 📜readme.md
┣ 📜start.bat
┗ 📜todo.md

⚡ Usage

🔌 Installation

$ git clone https://github.com/stiantha/DevTools.git
$ cd DevTools

📦 Commands

npm install
npm start

📖 Documentation

❓ FAQ

  • Q: How do I contribute to the project?
    • A: You can contribute to the project in several ways:
      • Report bugs
      • Request features
      • Create a pull request

🌟 Credit/Acknowledgment

Created by Stian Tharaldsen.

🔒 License

This project is licensed under the terms of the MIT license.

  • See the LICENSE file for details.