UPES Cloud Security Alliance - Frontend Repository

Welcome to the frontend repository of UPES Cloud Security Alliance built using React. This repository houses the codebase for the user interface of our application. We encourage contributions from the community to enhance and improve the frontend.

Table of Contents

• UPES Cloud Security Alliance - Frontend Repository
  • Table of Contents
  • Getting Started
    • Prerequisites
    • Installation
    • Contributing
      • Code Contribution Guidelines
    • Issue Reporting Guidelines
    • License
      • Thank you for contributing to UPES Cloud Security Alliance!

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js installed on your machine. You can download it from nodejs.org.
• npm (Node Package Manager) is required and comes with Node.js.

Installation

1. Clone the repository:

   git clone https://github.com/UPESCSA/UPESCSA-Website-Frontend.git

2. Navigate to the project directory:

   cd UPESCSA-Website-Frontend
   

3. Install the project dependencies:

   npm install
   

4. Start the development server:

   npm run dev
   

   The application should now be running at http://localhost:5173.

Contributing

We welcome contributions from the community. Whether it's fixing bugs, improving documentation, or adding new features, your contributions are highly appreciated.

Code Contribution Guidelines

1. Fork the repository and create your branch:

   git checkout -b your-feature
   

2. Make your changes and commit them:

   git add .
   git commit -m "Add your meaningful commit message"
   

3. Push to your branch:

   git push origin your-feature
   

4. Open a pull request on GitHub, explaining your changes and why they should be merged.

Issue Reporting Guidelines

If you encounter any issues or have suggestions, please follow these guidelines when creating a new issue:

1. Clearly describe the issue, including steps to reproduce it.
2. If applicable, provide screenshots or code snippets to help understand the problem.
3. Specify the version of the software you are using.
4. Check the existing issues to avoid duplicates.

License

This project is licensed under the MIT License. Feel free to use, modify, and distribute the code for both personal and commercial purposes.

Thank you for contributing to UPES Cloud Security Alliance!