⚠️ Development stopped, contact @theS1LV3R for organization name transfer or other questions ⚠️

CTFNote Documentation

The documentation page for CTFNote, both backend and frontend
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project (TODO)
  • Built With and Using
• Getting Started
  • Prerequisites
  • Installation
• Usage (TODO)
• Roadmap
• Contributing
• License

About The Project (TODO)

![Product Name Screen Shot][product-screenshot]

Built With and Using

• Typescript
• Node.js
• Yarn
• VuePress

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• yarn

npm install yarn@latest -g

Installation

1. Clone the repo

git clone https://github.com/CTFNote/documentation.git

2. Install NPM packages

yarn install

Usage (TODO)

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

License

Distributed under the GNU GPL v3 License. See LICENSE for more information.

---

This template was originally made from this repository by CSIVitu.