CDS Website

Website for the largest community of tomorrow's open source developers.

Table of Contents

• Table of Contents
• Getting Started
  • Prerequisites
  • Installation
• Folder Structure
• Scripts
• Built With
• Contributing
• Contributors
• License
• Acknowledgments

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

List any software or dependencies that need to be installed before setting up the project.

Installation

A step-by-step guide on how to get the development environment running.

# Clone the repository
git clone https://github.com/CodeDeployingSquad/cds-website.git

# Navigate to the project folder
cd cds-website

# Install dependencies
pnpm install

Folder Structure

• components - dir for all the essential components
• content - dir for all the constant content data
• pages - dir for all the pages
  • api - dir for all the essential apis including opengraph api
  • blog - dir for all the blogs
    • _meta.json - file for configuring site and page structure
  • docs - dir for all the documentation pages
    • _meta.json - file for configuring site and page structure
• public -dir for all the serve static files
• theme.config.tsx - file for configuring Nextra Docs theme

Scripts

# Run the development server
pnpm run dev

# Build the project for production
pnpm run build

# Start the production server
pnpm start

Built With

• https://nextra.site
• https://reactjs.org
• https://nextjs.org
• https://mdxjs.com
• https://pnpm.io
• https://tailwindcss.com

Contributing

For contributing checkout our Contributing Guide

For more guidance checkout All Guides

Contributors

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

• https://github.com/pacocoursey/next-themes
• https://github.com/garmeeh/next-seo
• https://github.com/hashicorp/next-mdx-remote
• https://github.com/shikijs/shiki
• https://github.com/nextapps-de/flexsearch
• https://github.com/atomiks/rehype-pretty-code
• https://github.com/Brooooooklyn/simple-git
• https://github.com/francoismassart/eslint-plugin-tailwindcss