Skip to content

saipranay47/webcrafts

Repository files navigation

Web Crafts

Web Crafts is a project aimed at building the world's best community for web developers. It provides a platform for web developers to share their knowledge, collaborate with others, expand their skills, get feedback on their work, and even find job opportunities.

webcrafts.demo.mp4

Project Setup

To get started with Web Crafts, make sure you have the following dependencies installed:

  • Node.js
  • npm (Node Package Manager)

Installation

  1. Clone the repository:

    shellCopy code

    git clone https://github.com/saipranay47/webcrafts.git

  2. Navigate to the project directory:

    shellCopy code

    cd webcrafts

  3. Install the project dependencies:

    shellCopy code

    npm install

Usage

Once you have installed the dependencies, you can use the following npm scripts to run different tasks:

  • npm run dev: Starts the development server using Vite.
  • npm run build: Builds the production-ready optimized version of the project.
  • npm run lint: Lints the source code using ESLint.
  • npm run preview: Serves the built project for previewing it locally.

Project Structure

The project structure follows a typical setup for a React application. Here are some important files and directories:

  • src/: Contains the source code of the application.
  • src/components/: Contains reusable React components.
  • src/pages/: Contains the individual pages of the application.
  • src/App.js: The main entry point of the application.
  • tailwind.config.js: The configuration file for Tailwind CSS.

Dependencies

Web Crafts uses various dependencies to enhance its functionality. Here are some key dependencies used in this project:

  • @headlessui/react: A set of accessible React components.
  • @heroicons/react: A set of free SVG icons for React.
  • @tailwindcss/forms: Tailwind CSS plugin for styling form elements.
  • @tailwindcss/line-clamp: Tailwind CSS plugin for truncating text with an ellipsis.
  • appwrite: A backend-as-a-service platform for building web and mobile apps.
  • axios: A promise-based HTTP client for making API requests.
  • clsx: A utility for constructing className strings conditionally.
  • metadata-scraper: A library for extracting metadata from web pages.
  • react: A JavaScript library for building user interfaces.
  • react-dom: The entry point of the React DOM package.
  • react-github-calendar: A React component for rendering a GitHub contribution calendar.
  • react-router-dom: A collection of navigational components for React Router.
  • react-share: A set of social media sharing buttons and icons for React.
  • slugify: A library for converting strings into slugs.

Dev Dependencies

Dev dependencies are tools and libraries used during the development process but are not required in the production build. Here are some dev dependencies used in this project:

  • @types/react: Type declarations for React.
  • @types/react-dom: Type declarations for React DOM.
  • @vitejs/plugin-react: Vite plugin for React development.
  • autoprefixer: A PostCSS plugin for adding vendor prefixes automatically.
  • eslint: A pluggable linting utility for JavaScript and JSX.
  • eslint-plugin-react: ESLint plugin for React-specific linting rules.
  • eslint-plugin-react-hooks: ESLint plugin for React Hooks linting rules.
  • eslint-plugin-react-refresh: ESLint plugin for React Refresh linting rules.
  • postcss: A tool for transforming CSS with JavaScript.
  • tailwindcss: A utility-first CSS framework.
  • vite: A fast development build tool.

Contribution

Web Crafts was initially built for the Appwrite Hashnode Hackathon. Contributions to this project are welcome! If you have any suggestions, bug reports, or feature requests, please feel free to open an issue or submit a pull request on the project's GitHub repository.

License

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

Releases

No releases published

Packages

No packages published

Languages