Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jnchi committed Oct 31, 2019
1 parent 403880c commit ed97db7
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 48 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# TallyCTF

> Capture The Flag Scoreboard and Event Management
## Table of Contents

- [Install](#install)
- [Usage](#usage)
- [Contribute](#contribute)
- [License](#license)

## Install
Install [Node v10 LTS](https://nodejs.org/en/about/releases) via the [official installer](https://nodejs.org/download/release/latest-v10.x) then install Gulp globally.

NOTE: Using the legacy Node installation has caused installation errors in the past, so it's recommended to use the most recent version.

```sh
npm install -g gulp
```

From the project root run:

```sh
npm install
```

## Usage

To serve the application locally simply run

```sh
gulp
```

The default task runs the project using a development environment.

To seed the database with an admin and initial user run

```sh
MONGO_SEED=true npm start
```

the CLI output will include the passwords. Be sure to run this only once unless you mean to overwrite the admin's password.

## Contribute

PRs accepted.

## License

[GPL-3.0](LICENSE)
48 changes: 0 additions & 48 deletions readme.md

This file was deleted.

0 comments on commit ed97db7

Please sign in to comment.