rmcampos
749ddbcdad
# What - Closes #17 # Why - Keep the repo updated with needed files onlyReviewed-on: #18
2.7 KiB
🤝 Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
This project is an opensource project, meaning you can contribute as many times as you want! We work with the Fork & Merge flow.
If you want to contribute, please create a fork and a Merge Request. Take a look here to learn more.
Steps to Contribute
- Fork the Project
- Clone it on your local (
git clone https://lightroasted.vps-kinghost.net/rmcampos/tasknote.git) - Develop your amazing feature/changes
- Make sure your name is set (
git config user.name 'YOUR NAME'; git config user.email 'YOUR EMAIL') - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the Branch (
git push) - Open a Merge Request
🏃♀️ Running locally
If your OS is Microsoft Windows, make sure to run this on a Linux VM over WSL2.
The easiest way of having the app up and running is using Docker. Once you're all set, follow these steps to see it live locally:
- Start the database engine (PostgreSQL)
task dev-run-db - Start the back-end engine (Java & Spring Boot)
task dev-run-api - Start the app server
task dev-run-web
Remember to follow up logs with 'docker ps' and 'docker logs -f '
Or start all services at once with Docker Compose:
docker compose -f docker-compose.dev.yml up -d
If everything went well, you can head to http://localhost:5000 and create your user.
🦾 Automation
Once you finish your changes, just create a Merge Request to get started.
This project has workflows to ensure quality code, including linting, testing and security checks. Your changes will be merged only after all check passes.
You can check locally if changes are passing:
- Back-end
bash tools/check-backend.sh - Front-end
bash tools/check-frontend.sh
Remember to follow up logs with 'docker ps' and 'docker logs -f '
Debugging Java
You might need to create a launch.json file. Here's a working one
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"type": "java",
"name": "Debug (Attach)",
"request": "attach",
"hostName": "localhost",
"port": 5005
}
]
}