Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pandermatt/hatey-bot-frontend
🤬🤖 Haley Bot Frontend
https://github.com/pandermatt/hatey-bot-frontend
Last synced: 6 days ago
JSON representation
🤬🤖 Haley Bot Frontend
- Host: GitHub
- URL: https://github.com/pandermatt/hatey-bot-frontend
- Owner: pandermatt
- Created: 2022-09-26T13:37:58.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-04T17:14:09.000Z (10 months ago)
- Last Synced: 2024-02-04T20:10:02.504Z (10 months ago)
- Language: JavaScript
- Homepage: https://pandermatt.ch/hatey-bot-backend/
- Size: 3.01 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🤬🤖 Hatey Bot Frontend
## Important Links
- [Website hatey.monster](https://hatey.monster)
- [Swagger Documentation api.hatey.monster](https://api.hatey.monster)
- [Frontend GitHub](https://github.com/pandermatt/hatey-bot-frontend) [](https://github.com/pandermatt/hatey-bot-frontend/actions/workflows/deploy.yml)
- [Backend GitHub](https://github.com/pandermatt/hatey-bot-backend)
- [LaTeX Documentation](https://www.overleaf.com/project/633592679211c2009c8bce96)
## Development
The frontend is a React app. It is automatically deployed to [hatey.monster](https://hatey.monster) when a new commit is pushed to the `main` branch.
The deployment is done by GitHub Actions and can be found in the [deploy.yml](.github/workflows/deploy.yml) file.
The swagger documentation is automatically generated by the backend and can be found at [api.hatey.monster](https://api.hatey.monster).
### Setup
```bash
git clone [email protected]:pandermatt/hatey-bot-frontend.git
cd hatey-bot-frontend
# Install dependencies
npm install
```
### Run
```bash
npm start
```
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
### Build
```bash
npm run build
```
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
## Contributors
Made with ❤️ by Pascal, Tobias and Denis
