number-neighbors

number-neighbors is using Java and Postgres.

Installation

1. Clone the repository

git clone git@github.com:kucera-lukas/number-neighbors.git

2. Generate RSA key pair

bash scripts/gen-keys.bash

Server

Local

1. Install Java https://www.java.com/en/download/
2. Install Maven https://maven.apache.org/install.html
3. Install PostgreSQL https://www.postgresql.org/download/
4. Install dependencies

mvn clean package -DskipTests=true

5. Fill environment variables into .env file

# in the src/main/resources directory
cp .env.example .env

Docker

Installation using Docker is recommended if you don't want to install all dependencies locally on your machine.

Currently no additional setup is required.

Client

# in the web directory
npm install

Development

Server

Local

mvn spring-boot:run -Dspring.profiles.active=dev

Docker

docker-compose up

Client

# in the web directory
npm run dev

Contributing

pre-commit install

License

Developed under the MIT license.