An open API service indexing awesome lists of open source software.

https://github.com/hackthevalley/hack-the-back-admin

A single-page admin dashboard for Hack the Back.
https://github.com/hackthevalley/hack-the-back-admin

Last synced: about 2 months ago
JSON representation

A single-page admin dashboard for Hack the Back.

Awesome Lists containing this project

README

          

# Hack the Back Admin

A single-page admin dashboard for [Hack the Back](https://github.com/hackthevalley/hack-the-back).

## Getting Started

For development and testing purposes, follow these instructions to get a copy of the project up and running on your local machine. Note that this project was bootstrapped with Create React App.

### Prerequisites

- Node.js v14+
- A running instance of [Hack the Back](https://github.com/hackthevalley/hack-the-back)

### Installing

1. Clone the repository - `git clone https://github.com/hackthevalley/hack-the-back-admin.git`

2. Enter the project directory - `cd hack-the-back-admin`

3. Install dependencies - `npm install`

### Configuration

The following envionment variables are available to be set:

- **`REACT_APP_HTB_API`** (Required) - Base URI of a running instance of Hack the Back. If you are running Hack the Back locally with the default settings, set `REACT_APP_HTB_API` to `http://localhost:8000`.

### Development

To start the development server run:

```
$ npm start
```

*Open [http://localhost:3000](http://localhost:3000) to view it in the browser.*

### Production

To build the application bundle run:

```
$ npm run build
```

## License

Everything in this repository is under the [MIT License](./LICENSE). Please carefully read and comply with the [license](./LICENSE) agreement.

**Created with :heart:  by [Hack the Valley](https://hackthevalley.io/).**

---