A website similar to quora.
The trello_quora project aims to develop REST API endpoints of various functionalities required for a website similar to Quora from scratch. In order to observe the functionality of the endpoints, you will use the Swagger user interface and store the data in the PostgreSQL database. Also, the project has to be implemented using Java Persistence API (JPA).
Git Best Practices
• Commit often • Make small, incremental commits • Write good commit messages • Make sure your code works before committing it
Using GitHub with IntelliJ in GUI Pull - Commit - Push
-
Init git
-
Right click the project name --> Git --> Repository --> Pull
-
Choose your branch and the master and click pull button from the dialogue box
-
Right click the project name --> Git --> Commit (or commit directory)
-
Uncheck . idea files and Commit
-
Right click the project name --> Git --> Repository --> Push
-
Go to your GitHub profile, refresh the page and check your branch
-
Create pull request
You can include verifiers for your pull request. You can either wait for the moderator/ team leader to merge it with master or if you are very much sure of functionality, you can also merge. It's always good to pull and then start working, and before pushing too, do pull to check for any conflicts.
Using GitHub by command line (some useful commands)
-
git init
-
git add or git add .
-
git pull origin master
-
git commit -m "commit message"
-
git push
Frequently used git commands are,
git fetch
git status
git log
To shift to a branch: git checkout
To roll back a commit: git revert <commit-ID / SHA>
Always create branches to implement different functionalities and then merge it with the master.
Setup Instructions (For Windows)
-
Install IntelliJ
-
Install Postgres (pgAdmin4)
-
Install JDK (1.8) from Java SE development
-
Install Maven
-
Setup environmental variables for JDK, and Maven
-
Download PostgreSQL JDBC 4.2 driver and add it as external jar file to the IntelliJ project
-
Implement the project
-
Build it using the mvn commands shown below
-
Run the application/project and open it on the localhost
Building the project
Commands to be used in terminal are;
mvn clean install -DskipTests
mvn clean install -Psetup
To run the application in localhost
localhost:8081/api/swagger-ui.html
[Note: Here, the port 8081 is used to run the localhost]