π A REST API server used for handling users pages containing their social media links. Project contains Java Spring Boot app as a backend (server). Database used in this project is MySQL.
- Managing your own page with social media links
- Adding, editing or deleting previously added social media links
- Editing your profile custom link (alias), title & bio
- Listing other users profiles with their social media links
π Documentation of all available endpoints can be found here: API Documentation
- Clone repository
git clone https://github.com/jakubcieslik99/linkscope-server.git
βΉοΈ Instructions for running server app locally:
- install Maven dependencies
- configure
env.properties
file for development/testing mode - run
App.java
file
βΉοΈ Instructions for building and running server app in production
- Compile and build
.jar
file using Maven scriptpackage
- Run
.jar
file on your server
java -jar linkscope-server.jar
βοΈ To run server app, you will need to add the following environment variables to your env.properties file
-
ENV
-
PORT
-
API_URL
-
WEBAPP_URL
-
MYSQL_URI
-
MYSQL_USER
-
MYSQL_PASSWORD
-
JWT_ACCESS_TOKEN_SECRET
-
JWT_REFRESH_TOKEN_SECRET
π€ Available API messages languages: EN
If you have any feedback, please reach out to me at βοΈ [email protected]