diff --git a/README.md b/README.md index ef5a6cef..175e46dd 100644 --- a/README.md +++ b/README.md @@ -11,20 +11,35 @@ Repository for the official GitHub Maintainer Month website. You can access the ## Table of Contents - [Getting Started](#getting-started) + - [Prerequisites](#prerequisites) - [Installation](#installation) - [Usage](#usage) - [Build](#build) + - [Testing](#testing) +- [Project Structure](#project-structure) +- [Adding Events](#adding-events) +- [Deployment](#deployment) - [Contributing](#contributing) - [Code of Conduct](#code-of-conduct) +- [Maintainer Month Origins](#maintainer-month-origins) - [License](#license) ## Getting Started +### Prerequisites + +- Node.js (version 16.x or higher recommended) +- npm or yarn + ### Installation Run the following command before any other to install all the project's dependencies. -``` +```bash +# Using npm +npm install + +# Using yarn yarn install ``` @@ -32,20 +47,64 @@ yarn install To start application in development mode at [http://localhost:3000](http://localhost:3000) run the following command. -``` -yarn start +```bash +# Using npm +npm run dev + +# Using yarn +yarn dev ``` ### Build To generate the application build run the following command -``` +```bash +# Using npm +npm run build + +# Using yarn yarn build ``` This will create an `out` folder in the repository root with the static files. +### Testing + +To run the test suite: + +```bash +# Using npm +npm test + +# Using yarn +yarn test +``` + +## Project Structure + +This project is built with Next.js and React, with SASS for styling: + +- `/components` - React components for the website +- `/pages` - Next.js pages +- `/public` - Static assets +- `/styles` - SASS stylesheets +- `/content` - Content files for events, news, and other information +- `/api` - API endpoints + +## Adding Events + +To add an event to Maintainer Month 2025: + +1. Create a new Markdown file in the `/content/events/` directory +2. Name it with format `YYYY-MM-DD-EventName.md` +3. Include the required frontmatter (details in [CONTRIBUTING.md](CONTRIBUTING.md)) +4. Submit a pull request with your changes + +## Deployment + +The site is automatically deployed when changes are merged to the main branch. + ## Contributing See the [contributing guide](CONTRIBUTING.md) for more details. @@ -62,3 +121,4 @@ Maintainer Month was created, and is maintained, by GitHub, starting in 2021 as Copyright © 2025 [GitHub](https://github.com/github).
This project is [MIT](LICENSE) licensed. +