-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
51 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |