Skip to content

Latest commit

 

History

History
109 lines (83 loc) · 4.13 KB

README.md

File metadata and controls

109 lines (83 loc) · 4.13 KB
Raw

DevScripts

DevScripts is a Next.js-based web application designed to be a go-to resource for developers. This platform provides meticulously crafted programming content and extensive web development documentation, equipping developers with the essential tools and knowledge to build efficient, scalable, and modern web applications.

Features

  • Comprehensive Documentation: Detailed guides and tutorials covering various aspects of web development, from front-end frameworks to back-end systems.
  • Automation Scripts: A collection of scripts that automate common development tasks, improving productivity and workflow.
  • Code Snippets: A library of reusable code snippets that can be easily integrated into your projects.
  • Responsive Design: Built with Tailwind CSS to ensure the application is fully responsive and visually appealing on all devices.
  • Modern Tech Stack: Powered by Next.js, React, and Tailwind CSS, ensuring a modern and high-performance development experience.

Getting Started

To set up the project locally, follow these steps:

Prerequisites

  • Node.js (version 14.x or higher recommended)
  • npm or yarn

Installation

  1. Clone the repository: 
    git clone https://github.com/rirefat/devscripts.git
cd devscripts
  2. Install the dependencies: 
    npm install
# or
yarn install
  3. Run the development server: 
    npm run dev
# or
yarn dev

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

Building for Production

To build the project for production, use the following command:

npm run build
# or
yarn build

This will create an optimized build in the .next folder, ready for deployment.

Contribution Guidelines

We welcome contributions to enhance the functionality and documentation of DevScripts. Please follow these steps to contribute:

  1. Fork the repository on GitHub

  2. Clone your forked repository:

    git clone https://github.com/your-username/devscripts.git

  3. Create a new branch for your feature or bugfix:

    git checkout -b feature-or-bugfix-name

  4. Make your changes and commit them with clear and descriptive messages.

  5. Push your changes to your forked repository:

    git push origin feature-or-bugfix-name

  6. Submit a Pull Request to the main branch of the original repository.

  7. Review process: Your pull request will be reviewed, and once approved, it will be merged into the main branch.

Contributing Content

DevScripts aims to provide high-quality, well-structured content that is easy to read and follow. If you're interested in contributing content, please adhere to the following format:

Content Format

  1. Metadata: Include metadata at the top of your content file in the following format:

    ---
title: "Title of the Article"
date: YYYY-MM-DD
author: "Your Name"
category: "Category Name"
tags: ["tag1", "tag2", "tag3"]
---

contents such as introduction, conclusion, references, etc.

  2. Table of Contents: Include a table of contents for longer articles to help readers navigate the content easily.

  3. Introduction: Start with an introduction that provides an overview of the topic and what the reader will learn.

  4. Detailed Sections: Break down the content into sections with clear headings. Use code examples where applicable, and explain them thoroughly.

  5. Conclusion: Summarize the key points and, if applicable, suggest further reading or next steps.

  6. References: If you used external sources, cite them at the end of the article.

Submitting Content

  1. Follow the Content Format: Ensure your content follows the structure outlined above.

  2. Create a New Branch:

    git checkout -b add-new-content

  3. Add Your Content: Place your markdown file in the appropriate directory within the content folder.

  4. Commit Your Changes:

    git commit -m "Add article on [topic]"

  5. Push Your Branch and submit a pull request to the main repository.

Contact

For any inquiries or suggestions, feel free to contact me via GitHub.