Commit d072b2ed authored by Olaf Rosendahl's avatar Olaf Rosendahl 💻
Browse files

Update readme.md

parent 81c2f951
Pipeline #81973 passed with stage
in 25 seconds
......@@ -15,7 +15,7 @@ These instructions will get you a copy of the project up and running on your loc
git clone git@gitlab.stud.idi.ntnu.no:gruppe-12/picturerama.git
```
In order to be able to connect to our database, and be able to upload local images, you'll need a ```config.properties``` file in the project root. It should look like this:
In order to be able to connect to our database, be able to upload local images and use the map, you'll need a ```config.properties``` file in the project root. It should look like this:
```
username=your_username
password=your_password
......@@ -27,7 +27,7 @@ google_maps_api_key=your_google_maps_api_key
```
Contact one of the developers to get the username and password.
Contact one of the developers to get our config.properties file.
If you want to setup your own database for the application. Run the SetupDatabase file in the Main folder in the project, and use your own info in the config.properties file.
......@@ -42,14 +42,6 @@ You should now have the files you need. In order to be able to run, you have to
If you don't have a JavaFxApplication.iml file in the project root, you'll have to add it. Copy and paste the JavaFxApplication.iml file at the bottom of this readme.md
## Rules
These rules are to be updated...
1. Use the IntelliJ IDEA shortcut ```CTRL+ALT+L``` in all changed files before committing. This will make all code stay formatted in the same way.
2. Branch should use the format: ```type/work-done```, where type is ```feat```, ```fix```, ```refactor``` or another appropriate typename. The work done should describe in a short way what you have done and will usually be the same as the issue-name
## JavaFxApplication.iml
```
<?xml version="1.0" encoding="UTF-8"?>
......@@ -58,7 +50,10 @@ These rules are to be updated...
<facet type="jpa" name="JPA">
<configuration>
<setting name="validation-enabled" value="true" />
<datasource-mapping />
<datasource-mapping>
<factory-entry name="Database" value="bf5a09e6-a24e-431b-a948-8d6107c78421" />
<factory-entry name="Database-setup" />
</datasource-mapping>
<naming-strategy-map />
<deploymentDescriptor name="persistence.xml" url="file://$MODULE_DIR$/src/main/resources/META-INF/persistence.xml" />
</configuration>
......@@ -68,9 +63,9 @@ These rules are to be updated...
<output url="file://$MODULE_DIR$/target/classes" />
<output-test url="file://$MODULE_DIR$/target/test-classes" />
<content url="file://$MODULE_DIR$">
<sourceFolder url="file://$MODULE_DIR$/src/main/App" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/src/main/resources" type="java-resource" />
<sourceFolder url="file://$MODULE_DIR$/Test" isTestSource="true" />
<sourceFolder url="file://$MODULE_DIR$/src/main/App" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/src/Test" isTestSource="true" />
<excludeFolder url="file://$MODULE_DIR$/target" />
</content>
<orderEntry type="inheritedJdk" />
......@@ -83,6 +78,10 @@ These rules are to be updated...
<orderEntry type="library" name="Maven: org.openjfx:javafx-base:win:11" level="project" />
<orderEntry type="library" name="Maven: org.openjfx:javafx-fxml:11" level="project" />
<orderEntry type="library" name="Maven: org.openjfx:javafx-fxml:win:11" level="project" />
<orderEntry type="library" name="Maven: org.openjfx:javafx-web:11" level="project" />
<orderEntry type="library" name="Maven: org.openjfx:javafx-web:win:11" level="project" />
<orderEntry type="library" name="Maven: org.openjfx:javafx-media:11" level="project" />
<orderEntry type="library" name="Maven: org.openjfx:javafx-media:win:11" level="project" />
<orderEntry type="library" name="Maven: mysql:mysql-connector-java:8.0.16" level="project" />
<orderEntry type="library" name="Maven: com.google.protobuf:protobuf-java:3.6.1" level="project" />
<orderEntry type="library" name="Maven: javaxt:javaxt-core:1.7.8" level="project" />
......@@ -104,16 +103,21 @@ These rules are to be updated...
<orderEntry type="library" name="Maven: com.sun.istack:istack-commons-runtime:3.0.7" level="project" />
<orderEntry type="library" name="Maven: org.jvnet.staxex:stax-ex:1.8" level="project" />
<orderEntry type="library" name="Maven: com.sun.xml.fastinfoset:FastInfoset:1.2.15" level="project" />
<orderEntry type="library" name="Maven: org.hibernate:hibernate-agroal:5.4.12.Final" level="project" />
<orderEntry type="library" name="Maven: io.agroal:agroal-pool:1.7" level="project" />
<orderEntry type="library" name="Maven: io.agroal:agroal-api:1.7" level="project" />
<orderEntry type="library" name="Maven: org.hibernate:hibernate-entitymanager:5.4.12.Final" level="project" />
<orderEntry type="library" scope="TEST" name="Maven: junit:junit:4.12" level="project" />
<orderEntry type="library" scope="TEST" name="Maven: org.hamcrest:hamcrest-core:1.3" level="project" />
<orderEntry type="library" scope="TEST" name="Maven: org.junit.jupiter:junit-jupiter-api:5.6.0" level="project" />
<orderEntry type="library" scope="TEST" name="Maven: org.apiguardian:apiguardian-api:1.1.0" level="project" />
<orderEntry type="library" scope="TEST" name="Maven: org.opentest4j:opentest4j:1.2.0" level="project" />
<orderEntry type="library" scope="TEST" name="Maven: org.junit.platform:junit-platform-commons:1.6.0" level="project" />
<orderEntry type="library" name="Maven: com.itextpdf:itextpdf:5.5.13.1" level="project" />
<orderEntry type="library" name="Maven: com.cloudinary:cloudinary-http44:1.25.0" level="project" />
<orderEntry type="library" name="Maven: com.cloudinary:cloudinary-core:1.25.0" level="project" />
<orderEntry type="library" name="Maven: org.apache.commons:commons-lang3:3.1" level="project" />
<orderEntry type="library" name="Maven: org.apache.httpcomponents:httpclient:4.4" level="project" />
<orderEntry type="library" name="Maven: org.apache.httpcomponents:httpcore:4.4" level="project" />
<orderEntry type="library" name="Maven: commons-logging:commons-logging:1.2" level="project" />
<orderEntry type="library" name="Maven: commons-codec:commons-codec:1.9" level="project" />
<orderEntry type="library" name="Maven: org.apache.httpcomponents:httpmime:4.4" level="project" />
</component>
</module>
```
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment