Skip to content

Commit da562be

Browse files
committed
reformatted README
1 parent 2b3216b commit da562be

File tree

1 file changed

+41
-14
lines changed

1 file changed

+41
-14
lines changed

README.md

Lines changed: 41 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,45 @@
1-
# java-spring-file-upload
1+
### Java Spring File Upload
22
Upload images using Java Spring MVC
33

4-
#Overview
4+
### Overview
55
In this simple application I am using Spring MVC and JPA (Hibernate) to persist User's information to the database including their profile photo/image.
66

7-
#Requirements
8-
1. MySQL database needs to be installed
9-
2. Internet connection to download the dependencies
10-
3. Coding eyes to understand the code :)
11-
12-
#Instructions
13-
1. Clone the project to your local machine
14-
2. Import the project into Spring Tool Suite/Eclipse
15-
3. Locate the Database folder and change the database name, username and password
16-
4. Open the modisefileupload.java.config.UserController and modify the image path (for development purposes you will need to point the path to you local computer, I have commented out the actual rootDirect to be used in the Server).
17-
5. Right click on the project and run on server
18-
6. Enjoy!
7+
### Requirements
8+
- MySQL database needs to be installed (https://dev.mysql.com/downloads/)
9+
- Internet connection to download the dependencies
10+
- Knowledge of Java and Spring framework
11+
12+
### Setup
13+
- Clone the project to your local machine
14+
- Import the project into Spring Tool Suite/Eclipse
15+
- Locate the Database folder and change the database name, username and password
16+
- Open the ```modisefileupload.java.config.UserController``` and
17+
modify the image path (for development purposes you will need to point the path to you local computer,
18+
I have commented out the actual `rootDirect` to be used in the Server).
19+
- Right click on the project and run on server
20+
- Enjoy!
21+
22+
23+
### License
24+
```
25+
The MIT License (MIT)
26+
27+
Copyright (c) 2016 Morebodi Modise
28+
29+
Permission is hereby granted, free of charge, to any person obtaining a copy
30+
of this software and associated documentation files (the "Software"), to deal
31+
in the Software without restriction, including without limitation the rights
32+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
33+
copies of the Software, and to permit persons to whom the Software is
34+
furnished to do so, subject to the following conditions:
35+
36+
The above copyright notice and this permission notice shall be included in all
37+
copies or substantial portions of the Software.
38+
39+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
40+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
41+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
42+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
43+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
44+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
45+
SOFTWARE.```

0 commit comments

Comments
 (0)