Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
garrappachc committed Mar 26, 2021
0 parents commit 5637395
Show file tree
Hide file tree
Showing 29 changed files with 11,263 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Website

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

## Installation

```console
yarn install
```

## Local Development

```console
yarn start
```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

## Build

```console
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

```console
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
11 changes: 11 additions & 0 deletions blog/2019-05-28-hola.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
slug: hola
title: Hola
author: Gao Wei
author_title: Docusaurus Core Team
author_url: https://github.com/wgao19
author_image_url: https://avatars1.githubusercontent.com/u/2055384?v=4
tags: [hola, docusaurus]
---

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
17 changes: 17 additions & 0 deletions blog/2019-05-29-hello-world.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
slug: hello-world
title: Hello
author: Endilie Yacop Sucipto
author_title: Maintainer of Docusaurus
author_url: https://github.com/endiliey
author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
tags: [hello, docusaurus]
---

Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).

<!--truncate-->

This is a test post.

A whole bunch of other information.
13 changes: 13 additions & 0 deletions blog/2019-05-30-welcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
slug: welcome
title: Welcome
author: Yangshun Tay
author_title: Front End Engineer @ Facebook
author_url: https://github.com/yangshun
author_image_url: https://avatars0.githubusercontent.com/u/1315101?s=400&v=4
tags: [facebook, hello, docusaurus]
---

Blog features are powered by the blog plugin. Simply add files to the `blog` directory. It supports tags as well!

Delete the whole directory if you don't want the blog features. As simple as that!
42 changes: 42 additions & 0 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: About
slug: /
---

## The goal

tf2pickup.pl is a place where any competitive Team Fortress 2 player can play a well-balanced match, ...

It is a place for the beginners to play with more experienced players and learn from them, as well as for those
who have been playing competitive Team Fortress 2 for quite some time now and want to relax with their favourite game.

## The drive

What competitive Team Fortress 2 has been struggling with since always, is growing the playerbase. For those who are new to
the game, the options to play a good 6v6 or 9v9 match are quite limited. It has always been my opinion that you get better
at the game by playing with more experienced players and learning from them. **tf2pickup.pl** is aimed at making it possible
for players of all levels of experience to play together a well-balanced games, where there are no 5-0 rolls and there is a relaxed
and friendly atmosphere.

## The history

The tf2pickup.pl project was started in July 2019 as a small service for Polish TF2 competitive scene. We wanted to include
as many fresh players as possible and with double mixes it was pretty difficult. tf2pickup.pl's aim was to create a friendly
and welcoming environment where everyone interested in 6v6 format could find their place.

At first it was only the Polish service for 6v6 gamemode, but soon enough we learned there is a demand for more gamemodes in more
countries. After [tf2pickup.pl](https://tf2pickup.pl/) initial success, we launched [hl.tf2pickup.pl](https://hl.tf2pickup.pl/),
Polish 9v9 pickups and [tf2pickup.es](https://tf2pickup.es/), Spanish 6v6 pickups. Currently, we have also founded
[French](https://tf2pickup.fr/), [Czech](https://tf2pickup.cz/) and [German](https://tf2pickup.de/) 6v6 pickups and we are looking
forwarding to seeing many more.

## What tf2pickup.pl is

We give you an open-source, MIT-licenced project with all our best intentions and support. Although the project name is tf2pickup.**pl**, it
is not limited to Polish domain. In fact, anyone could launch their own instance of tf2pickup.pl, with their own branding and configuration.

## What tf2pickup.pl is NOT

tf2pickup.pl relies on admins to balance the games. There is no ELO system, no automatic skill recognition, nor a captain-pick system.
Each player has assigned a skill number on each class in the current gamemode and that number is edited by hand, by admins.
Therefore it requires **a lot of admins' attention** and dedication to run proper tf2pickup.pl service.
26 changes: 26 additions & 0 deletions docs/components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Components
---

In order to run a fully fledged tf2pickup.pl instance, you are going to set up and configure a couple of components.

## The server

This is the backend of the whole system. It is responsible for accessing the database, configuring game servers and much more.
Read how to deploy and configure one here.

## The client

This is the frontend, the webpage itself. You can configure your own look'n'feel so that the service looks unique.
It communicates with the server and presents the data to the user in a accessible, eye-catching and user-friendly way.
Here you will find the documentation on how to prepare your own branding, how to build the client and how to deploy it.

## The voice server

Currently, tf2pickup.pl supports only [Mumble](https://www.mumble.info/), but there are plans to support Discord voice
channels as well.

## The game server

To launch a game, a game server is needed. We provide a [docker image](https://github.com/tf2pickup-pl/tf2-gameserver)
that has all the plugins and configuration.
25 changes: 25 additions & 0 deletions docs/create-a-blog-post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Create a Blog Post
---

This page will help you on how to create blog posts in Docusaurus.

## Create a Blog Post

Create a file at `blog/2021-02-28-greetings.md`:

```md title="blog/2021-02-28-greetings.md"
---
title: Greetings!
author: Steven Hansel
author_title: Docusaurus Contributor
author_url: https://github.com/ShinteiMai
author_image_url: https://github.com/ShinteiMai.png
---

Congratulations, you have made your first post!

Feel free to play around and edit this post as much you like.
```

A new blog post is now available at `http://localhost:3000/blog/greetings`.
38 changes: 38 additions & 0 deletions docs/create-a-document.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Create a Document
---

Documents are pages with a **sidebar**, a **previous/next navigation** and many other useful features.

## Create a Document

Create a markdown file at `docs/my-doc.md`:

```mdx title="docs/hello.md"
---
title: Hello, World!
---

## Hello, World!

This is your first document in **Docusaurus**, Congratulations!
```

A new document is now available at `http://localhost:3000/docs/hello`.

## Add your document to the sidebar

Add `hello` to the `sidebars.js` file:

```diff title="sidebars.js"
module.exports = {
docs: [
{
type: 'category',
label: 'Docusaurus Tutorial',
- items: ['getting-started', 'create-a-doc', ...],
+ items: ['getting-started', 'create-a-doc', 'hello', ...],
},
],
};
```
45 changes: 45 additions & 0 deletions docs/create-a-page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Create a Page
---

Any React or Markdown file created under `src/pages` directory is converted into a website page:

- `src/pages/index.js` -> `localhost:3000/`
- `src/pages/foo.md` -> `localhost:3000/foo`
- `src/pages/foo/bar.js` -> `localhost:3000/foo/bar`

## Create a React Page

Create a file at `src/pages/my-react-page.js`:

```jsx title="src/pages/my-react-page.js"
import React from 'react';
import Layout from '@theme/Layout';

function HelloWorld() {
return (
<Layout>
<h1>My React page</h1>
<p>This is a React page</p>
</Layout>
);
}
```

A new page is now available at `http://localhost:3000/my-react-page`.

## Create a Markdown Page

Create a file at `src/pages/my-markdown-page.md`:

```mdx title="src/pages/my-markdown-page.md"
---
title: My Markdown page
---

# My Markdown page

This is a Markdown page
```

A new page is now available at `http://localhost:3000/my-markdown-page`.
Loading

0 comments on commit 5637395

Please sign in to comment.