nishkarshraj / hostel-pass-management-application

Open Source Project. Developed under SiB Community.

Hostel-Pass-Management-Application

Pre-Requisites

1. Java JDK 1.8 or above installed on local system
2. Oracle 11g Express Edition or above for Database Management

How to execute

1. Clone this repository on your local machine

$ git clone "https://github.com/NishkarshRaj/Hostel-Pass-Management-Application.git"

2. Open SQL Plus on your local machine and configure Database by using the Creation and insertion files in dbms_files directory.

3. Visit src directory on your local machine via command line and type the following command:

$ cd {path to project}/src/
$ set classpath=C:\oraclexe\app\oracle\product\11.2.0\server\jdbc\lib\ojdbc6.jar;.

4. Execute the Main.java file in src directory

$ javac Main.java
$ java Main

Code of Conduct

Code of Conduct

How to Contribute

For contributing, check the guidelines here

Future Scope

1. Create a GUI version
2. Make an Attendance Management System and integrate it with this project
3. Use and online database for concurrency

hostel-pass-management-application's Issues

Central Online DBMS

Create an online DBMS for the application to use.
The application currently uses Oracle 11g Express Edition which has to be installed on the client side and configured initially for use of the application.

Add Maven as a Dependency Manager

Using Maven (or Gradle) would help make this project more accessible to contribution as well as making it a lot simpler to deal with dependencies down the road.

Create GUI for the application

This application runs on Java in command line mode.

1. Installed JDK 1.8 or above
2. Oracle 11g Express Edition installed on the client system.

Create a GUI for the same.

Format Code

Code style should be enforced, primarily to avoid unneccesary merge conflicts but also to make the current code look better. Google Java Style is very common and would improve this project. https://github.com/google/google-java-format

Automate the Configuration of Database on Local machine

As referenced in
https://github.com/NishkarshRaj/Hostel-Pass-Management-Application/blob/master/README.md

When the project is to be executed for the first time on the local machine, we have to create the database in SQL Plus and insert dummy values.
Create an automated pipeline using scripts etc. or configure dependency using Apache Maven which can be automated later using GitHub Action so that on execution of that script, it checks for the:

1. Installation of Java JDK and SQL on local machine
2. Creates and configures Database.

Restructuring/refactoring

• Business logic must be exposed as REST service in order to have seamless integration with UI.
• spring boot/ spring mvc can be used.
• Repository pattern with hibernate must be used.
• Docker/Container for dev.
• CI/CD builds with travis etc.
• Proper logging and exception handling for troubleshooting issues.
• unit test cases for more stability.
• strapi cms can also be used for this task.

Add OpenAPI Spec - To Cover the Context Boundry

• Develop an Open API Spec to initialize a contract for future UI development
• It will be good to document all the available services and Domain Model

I have given a start here
https://app.swaggerhub.com/apis-docs/VinodhThiagarajan1309/hostel-pass-management/0.0.1

Let me know if you want to develop further - @NishkarshRaj