CoderbaziApp 🚀🚀🚀

An application where we will writing a lot of APIs and creating some fun stuffs!

Tech-Stack: Java Spring boot, Mysql, Rest API

Want to Contribute and make your hands dirty💻?

Follow this steps:

1. Clone the repository

   • Open your IDE and run this command in Terminal
     

       git clone https://github.com/pratikpjain/CoderbaziApp.git

   • Though you can use any IDE but Intellij IDE is recommended for this project. IntelliJ IDE

2. To run the application

   • Go to com.example.CoderBazi.CoderBaziApplication and run this Java file.
   • You can open it at http://localhost:8080/
   • Make sure mysql database is running at port 3306 in your machine.

3. To add any new feature or any changes

   • Create a new branch

   git branch -b branch_name

   • Make the changes here
   • Test it on local [You can use POSTMAN for testing APIs]
   • Raise a PR(Pull Request)
   • Get review done from one of our contributers
   • Then merge it to main!
   • ☠Note: Please don't directly push any code to main branch without reviewing it as we are using main branch for deployment.

4. Database Migration

   • Go to src\main\resources\db\migration
   • Create a new file with the naming conventions V{MigrationNumber}__{Description}.sql
   • For example we are adding a new column to table Users and let this is the 3rd Migration, then name should be V3__AddNewColumnToUsers.sql
   • For running the migration, you can do Maven Install on IDE or simply run the app it would make the migrations.
   • Note: Not following this conventions may lead to error in migratons

Currently we are deploying the changes on Railway.app platform for the trial and testing purpose: https://coderbaziapp-production.up.railway.app/