SpringUni particles

springuni-particles is a toolbox for creating small footprint user management microservices. This repository is the first round implementation of that system which was described with article series A deep dive into implementing a user management application with Spring Boot.

Installation

Create .env with the following contents

PORT=5000
JDBC_DATABASE_URL=jdbc:mysql://<user>:<password>@localhost:3306/springuni?serverTimezone=UTC
JWT_TOKEN_SECRET_KEY=<strong random alpha numeric sequence>
REMEMBER_ME_TOKEN_SECRET_KEY=<strong random alpha numeric sequence>
...

2a) Compile and build with

`./mvnw clean install`

2b) Compile and build with skipping the integration tests

`./mvnw clean install -Dskip.integration.tests=true`

Start locally with

./mvnw -pl springuni-auth-boot spring-boot:run

Usage

TODO: Write usage instructions

Contributing

Fork it!
Create an issue describing the feature or bug fix you'd like to submit
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am '#N Add some feature'

Note: Use the issue number #N as the first word of every commit message.

Push to the branch: git push origin my-new-feature
Submit a pull request :D

History

TODO: Write history

Credits

TODO: Write credits

License

This library, springuni-particles, is free software ("Licensed Software"); you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; including but not limited to, the implied warranty of MERCHANTABILITY, NONINFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, see GNU Licenses.

haozileung / springuni-particles