https://github.com/le4ndro/bookmarks
Sample API project for bookmarking web sites using Spring Boot and PostgreSQL
https://github.com/le4ndro/bookmarks
postgresql rest-api spring-boot spring-data-jpa
Last synced: 3 months ago
JSON representation
Sample API project for bookmarking web sites using Spring Boot and PostgreSQL
- Host: GitHub
- URL: https://github.com/le4ndro/bookmarks
- Owner: le4ndro
- License: mit
- Created: 2019-02-09T20:23:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T17:37:52.000Z (10 months ago)
- Last Synced: 2025-01-18T06:13:26.155Z (5 months ago)
- Topics: postgresql, rest-api, spring-boot, spring-data-jpa
- Language: Java
- Size: 110 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bookmarks
Sample API project for bookmarking web sites using Spring Boot and PostgreSQL
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to install the software
* Java JDK 8
* Apache Maven
* PostgreSQL Database
### Installing
1. Clone this repository
```
$ git clone https://github.com/le4ndro/bookmarks.git
$ cd bookmarks
```
2. Create database on postgresql
```
$ createdb bookmarksdb
```
3. Make a local copy of set_env.sample.sh
```
$ cp set_env.sample.sh set_env.sh (or rename set_env.sample.bat to set_env.bat on Windows)
```
4. Edit your set_env.sh (or set_env.bat on Windows) file with your parameters and set variables for your environment
```
$ chmod 755 set_env.sh
$ source ./set_env.sh
(or run set_env.bat on Windows)
```
5. Run the application
```
$ mvn spring-boot:run
```
## Deployment
1. Create an executable jar
```
$ mvn package
```
2. Run the application
```
$ java -jar target/bookmarks-0.0.1-SNAPSHOT.jar
```
## Built With
* [Spring Boot](https://docs.spring.io/spring-boot/docs/1.3.1.RELEASE/reference/htmlsingle/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
* **Leandro Souza** - *Initial work*
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
## Acknowledgments
* This project is in development