jarryscript/ptah

Ptah is a software that manages the processes, human resources, contracts, and funds in construction engineering.

	The Ptah system is a web application for construction project management. And it is also my personal code kata that I can write basic codes which is very relax~

Getting Started

Prerequisites

To run this project, you must have the following prerequisites:

- Java 17
- Gradle 8.3
- PostgresSQL 12.0 or newer

Installation

To install this project, follow these steps:

1. Clone the repository to your local machine.
2. Configure the database connection in the application.yaml file.
3. Run the following command to build the project: gradle clean build.
4. Run the project using the following command: java -jar build/libs/ptah-0.0.1-SNAPSHOT.jar.

Usage

The project is providing backend services(APIs).

Once the project is running, you can visit http://localhost:8080/ptah/swagger-ui/index.html to check all exposed APIs.

Development

To develop this project further, follow these steps:

1. Clone the repository to your local machine.
2. Create a new branch for your changes: git checkout -b my-new-feature.
3. Make your changes and commit them: git commit -am 'Add some feature'.
4. Push your changes to the branch: git push origin my-new-feature.
5. Create a new pull request.

Author

• Jarry Zhou - https://jarryzhou.space

License

This project is licensed under the MIT License - see the LICENSE file for more details.