README.md

MeteoScientific Website

Welcome to the official repository for the MeteoScientific website, built using Docusaurus. This site provides documentation and guides for using the MeteoScientific Chirpstack Console.

Overview

This website is deployed using GitHub Pages and is intended to be a comprehensive resource for anyone working with ChirpStack on the MeteoScientific platform.

Getting Started

Prerequisites

To work on this project, you'll need the following tools installed on your local machine:

• Node.js
• npm
• Git

Installation

To get started with the project locally:

1. Clone the repository:

   git clone https://github.com/your-github-username/meteoscientific-website.git

2. Navigate to the project directory:

   cd meteoscientific-website

3. Install the dependencies:

   npm install

4. Run the development server:

   npm run start

Building the Site

To build the site for production:

npm run build

The build files will be generated in the build/ directory.

Contributing

We welcome contributions to improve the documentation and guides. If you'd like to contribute:

1. Fork this repository.
2. Create a new branch for your feature or bugfix:

   git checkout -b feature-name

3. Make your changes and commit them:

   git commit -m "Description of the changes"

4. Push your changes to your fork:

   git push origin feature-name

5. Submit a pull request to this repository's main branch.

Please ensure that your code adheres to the existing style and passes all tests.

Deployment

This site is automatically deployed to GitHub Pages using Docusaurus. To deploy the latest version:

npm run deploy

This will push the latest build to the gh-pages branch and update the live site.

License

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

Contact

If you have any questions or need support, feel free to open an issue or reach out via email.