maintainermonth/README.md

65 строки
1.9 KiB
Markdown
Исходник Постоянная ссылка Обычный вид История

# Maintainer Month
2022-04-06 15:12:18 +03:00
2022-04-14 19:30:10 +03:00
A month for open source maintainers to gather, share, and be celebrated. 🥳
2022-04-06 15:12:18 +03:00
2022-04-14 19:30:10 +03:00
Repository for the official GitHub Maintainer Month website. You can access the website through [this link](https://maintainermonth.github.com/)
2022-04-06 15:12:18 +03:00
2022-04-14 19:30:10 +03:00
**Add your event!** See the [contributing guide](CONTRIBUTING.md) for details on how.
2022-04-06 15:12:18 +03:00
2023-12-07 21:30:21 +03:00
**<p align="center"> ❇️ May 2024 ❇️ </p>**
2022-04-06 15:12:18 +03:00
## Table of Contents
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Build](#build)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
2022-04-06 17:46:01 +03:00
- [License](#license)
2021-04-04 19:05:29 +03:00
2022-03-14 17:03:26 +03:00
## Getting Started
2021-04-04 19:05:29 +03:00
2022-04-06 15:12:18 +03:00
### Installation
Run the following command before any other to install all the project's dependencies.
2021-04-06 10:03:42 +03:00
2022-03-14 17:03:26 +03:00
```
2022-04-06 15:12:18 +03:00
yarn install
```
### Usage
2021-04-04 19:05:29 +03:00
2022-04-06 15:12:18 +03:00
To start application in development mode at [http://localhost:3000](http://localhost:3000) run the following command.
2021-04-04 19:05:29 +03:00
2022-04-06 15:12:18 +03:00
```
yarn start
```
2021-04-04 19:05:29 +03:00
2022-04-06 15:12:18 +03:00
### Build
2021-04-04 19:05:29 +03:00
2022-04-06 15:12:18 +03:00
To generate the application build run the following command
```
yarn build
```
2021-04-05 00:49:47 +03:00
2022-04-06 15:12:18 +03:00
This will create an `out` folder in the repository root with the static files.
2021-04-04 19:05:29 +03:00
2022-04-06 15:12:18 +03:00
## Contributing
2021-04-04 19:05:29 +03:00
2022-04-06 15:12:18 +03:00
See the [contributing guide](CONTRIBUTING.md) for more details.
2021-04-04 19:05:29 +03:00
2022-04-06 15:12:18 +03:00
## Code of Conduct
2022-02-03 03:20:42 +03:00
2022-04-06 15:12:18 +03:00
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
2022-02-03 03:20:42 +03:00
## Maintainer Month Origins
Maintainer Month was created, and is maintained, by GitHub, starting in 2021 as Maintainer Week. It was simaeltaneously conceived of by Kara Sowles and Josh Simmons, who called each other to tell each other the same idea. It's intended as an industry-wide event that isn't owned by GitHub - that belongs to anyone who wants to contribute or participate. In includes an Advisory Council from folks across the industry that shape what it is.
2022-04-06 16:49:41 +03:00
## License
2022-02-03 03:20:42 +03:00
2023-04-21 16:44:21 +03:00
Copyright © 2023 [GitHub](https://github.com/github).<br />
2022-04-06 17:46:57 +03:00
This project is [MIT](LICENSE) licensed.