https://github.com/kir-dev/schbody
https://github.com/kir-dev/schbody
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kir-dev/schbody
- Owner: kir-dev
- Created: 2024-07-11T18:11:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-17T15:23:32.000Z (over 1 year ago)
- Last Synced: 2025-03-17T15:39:57.465Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://body.sch.bme.hu
- Size: 22.3 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SCHBodyđź’Ş
by Kir-Dev
A Schönherz Kollégium konditermének weboldala és adminisztrációs rendszere.
- Ha hibát találsz, kérlek nyiss egy issue-t!
- Ha részt akarsz venni a fejlesztésben, vedd fel a kapcsolatot velünk és nyiss egy pull requestet!
## Getting Started
### Prerequisites
- Node.js 20
- Yarn 4.5.1
### Installation
You only need to install dependencies in the root directory.
```bash
yarn install
```
### Linter and Formatter Configuration
It is a must to use ESLint and Prettier in this project.
Set up ESLint and Prettier in your IDE and check `fix on save` or `format on save` options.
You can run the following commands to check linting and formatting issues.
```bash
yarn lint
# or
yarn lint:fix
```
```bash
yarn format:check
# or
yarn format
```
### Development
You can run the backend and frontend separately.
```bash
yarn start:backend # Starts on http://localhost:3001
```
```bash
yarn start:frontend # Starts on http://localhost:3000
```
### After Development
You can build the frontend and run the application.
```bash
yarn build:frontend
```
Or build the backend.
```bash
yarn build:backend
```
There are recommended GitHub Actions workflows for this setup, which will fail if one of the following commands fails:
```bash
yarn lint
```
```bash
yarn format:check
```
```bash
yarn build:backend
```
## Happy Coding!