CDS Website

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

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

Contributing

For contributing checkout our Contributing Guide (opens in a new tab)

For more guidance checkout All Guides (opens in a new tab)

Contributors

License

This project is licensed under the MIT License (opens in a new tab) - see the LICENSE.md file for details.

Acknowledgments

Enhancement/Feature Request Template Thirdfunding