Please read the CONTRIBUTING.md first.
- Download the code.
- Ensure that "docker" and "docker compose" is installed and you get meaningful response when you type
docker compose version
on terminal. - Run
docker compose up
in the root folder. - That's it! You will be able to access the application from
http://localhost:8080
.
- Fork the project. While forking, disable "Copy only main branch" option.
- Ensure that you configured your ssh keys with github: https://docs.github.com/en/authentication/connecting-to-github-with-ssh
- Download the forked project with ssh option.
- Go to
develop
branch:git checkout develop
. And runnpm install
in the root folder of the project. - Update the project to the latest version:
git pull
- Select an issue from the
issues
tab. Let everyone know you are working on this issue, add a comment to the issue and you will be assigned. - Create a new branch for this issue:
git checkout -b <issue-id>-<short-description>
- After you are done with the task, send the changes:
git add .
git commit -m "<issue-id>: <A short meaningful description>"
git push -u origin <branch-name>
After successfully pushed the changes to the issue branch, open a pull request from forked repo's new branch to this repo's develop
branch(You can do it via github interface). Add a reviewer(for now @Mert18). That's it.
Example application.properties:
spring.datasource.url=jdbc:postgresql://localhost:5432/hire-a-senior
spring.datasource.username=postgres
spring.datasource.password=postgres
spring.datasource.driver-class-name=org.postgresql.Driver
spring.jpa.hibernate.ddl-auto=update
# swagger-ui custom path
springdoc.swagger-ui.path=/swagger-ui.html
jwt.secret=eyJhbGciOiJIUzI1NiyJ8zAeld3LfFTgPU3cAVxpKm7EnBVZxTWOVlCVI5kGg
# 1 day
jwt.accessExpirationDateInMs=86400000
# 3 days
jwt.refreshExpirationDateInMs= 259200000
sendgrid.key= <sendgrid-key>
email.from=mertplayschess@outlook.com
application.url=http://localhost:8080