https://github.com/kir-dev/rajk
The new website of Rajk Szakkollégium
https://github.com/kir-dev/rajk
Last synced: 5 months ago
JSON representation
The new website of Rajk Szakkollégium
- Host: GitHub
- URL: https://github.com/kir-dev/rajk
- Owner: kir-dev
- Created: 2025-04-07T12:49:47.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-12-17T01:35:41.000Z (6 months ago)
- Last Synced: 2025-12-20T10:44:57.807Z (6 months ago)
- Language: TypeScript
- Homepage: https://rajk-seven.vercel.app
- Size: 80.2 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Project Setup Guide
This guide will help you set up the project locally.
### Prerequisites
Ensure you have the following installed on your machine:
- Node.js (v16 or higher)
- Yarn (v1.22.22 or higher)
- Docker
### Installation Steps
1. **Clone the repository:**
```sh
git clone
```
2. **Install dependencies:**
```sh
yarn install
```
3. **Set up environment variables:**
- Copy the `.env.example` file to `.env`:
- Update the `.env` file with your specific values if necessary.
4. **Start the PostgreSQL database using Docker:**
```sh
docker-compose up -d
```
5. **Run the development server:**
```sh
yarn dev
```
### Additional Commands
- **Build the project:**
```sh
yarn build
```
- **Start the production server:**
```sh
yarn start
```
- **Lint the project:**
```sh
yarn lint
```
### Notes
- Ensure Docker is running before starting the development server.
- The database connection string and other secrets are managed in the `.env` file.
- The project uses Tailwind CSS for styling and Payload CMS for content management.