CDAO: College Decentralised Autonomous Organisation

Welcome to the CDAO-Site repository! This project aims to build the website presence of CDAO. This readme provides an overview of the repository and guidelines for contributing to the project.

Table of Contents

About the Project

The CDAO-Site project aims to create a website for the CDAO, serving as a platform to share information, resources, and event updates related to the org. The website will provide a user-friendly interface, enabling visitors to learn more about the organization and access valuable content.

Getting Started

To get started with the CDAO-site, follow the steps below.

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/c-d-a-o/cdao-site.git
  2. Navigate to the project directory:

    cd cdao-site
  3. Install the dependencies:

    npm install

Congratulations! You have successfully set up the project on your local machine.

Usage

To start the development server, use the following command:

npm start

This will launch the website locally, and you can view it by opening http://localhost:[port] in your web browser.

Contributing

We welcome contributions from everyone who is interested in improving the CDAO-Site project. To contribute, please follow these steps:

  1. Fork the repository.

  2. Create a new branch with a descriptive name:

    git checkout -b feature/your-feature-name
  3. Make your changes, adding new features or fixing bugs.

  4. Commit your changes:

    git commit -m "Add your commit message here"
  5. Push your branch to your forked repository:

    git push origin feature/your-feature-name

Open a pull request against the main branch of the original repository. Provide a clear and concise description of your changes.

Once your pull request is submitted, it will be reviewed by the project maintainers. Thank you for contributing!

Code of Conduct

We expect all contributors to follow the Code of Conduct while participating in this project.

Contact

If you have any questions or suggestions regarding the CDAO-Site project, please feel free to open an issue or contact the project maintainers:

Maintainers: Aman Chandra, Chetan Mittal, Arnav Anand

We appreciate your interest in the project and your valuable contributions!