Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knighthacks/admin-tool-frontend-2022
Repository for Knight Hacks admin tool frontend
https://github.com/knighthacks/admin-tool-frontend-2022
Last synced: 6 days ago
JSON representation
Repository for Knight Hacks admin tool frontend
- Host: GitHub
- URL: https://github.com/knighthacks/admin-tool-frontend-2022
- Owner: KnightHacks
- Created: 2022-08-05T20:22:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-15T08:56:27.000Z (over 1 year ago)
- Last Synced: 2024-05-29T17:14:26.047Z (6 months ago)
- Language: TypeScript
- Size: 57.4 MB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
2022 Knight Hacks Admin Tool
This repository is the home for the admin tool used by our hackathon organizers to manage hackathons and the attendees, sponsors, and events at each one.
## Installation
```shell
https://github.com/KnightHacks/admin-tool-frontend-2022
cd admin-tool-frontend-2022
npm install
```
You will also need to create a .env file at the top level directory of the project. The contents should contain the following keys:
```
# The URL of the Knight Hacks API you are targeting - ex: https://api-dev.knighthacks.org/
API_ENDPOINT=
```
## Getting Started
To run a live development server, run the following in a terminal:
```shell
npm run start
```
This will host the website at http://localhost:3000. As you make updates to the
code, the development server will automatically reload the page.
## Building the Docker Image Locally
Build this app into a Docker image:
```shell
docker build -t .
```
Run the image as a container:
```shell
docker run -itd -p 9090:9090 [--name ]
```
`-i, -t, -d, --name` are optional flags. Reference: https://docs.docker.com/engine/reference/run/.
`-p 9090:9090` is required and based on the configured port in the Dockerfile and the NGINX config (default.config).
You can now use the website through the url `http://localhost:9090` in your browser of choice.
## Updating the API Submodule
To get any changes made to the API submodule, run `git submodule update --remote`
For a detailed guide of handling submodules, see [here](https://git-scm.com/book/en/v2/Git-Tools-Submodules)