daverbk / evolve

Social network backend ๐ŸŽž๏ธ

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Evolve

Description

Evolve was thought to be a network for individuals aimed at self-development and positive improvements fostering. As we ran out of efforts to make it complete, it was decided to leave it here just to showcase backend of the project.

Getting Started Locally

Prerequisites

  • Java 17 or higher
  • Maven 3.9.6 or higher
  • Docker daemon running

Local Setup

  1. Clone the repository
git clone https://github.com/daverbk/evolve.git
  1. Switch to the backend project directory
cd evolve/backend
  1. Build the project
mvn clean install
  1. Run the project
mvn spring-boot:run

Entities diagram

Entities diagram

Usage

  1. User has to first sign up and receive a confirmation email
  2. User has to confirm the email mentioned in the registration phase via clicking the link sent to the email Email example
  3. User can sign in and use a jwt token to access the resources

Check out Swagger UI at http://localhost:8080/swagger-ui/index.html

Contributing

Check out our contributing guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Social network backend ๐ŸŽž๏ธ

License:MIT License


Languages

Language:Java 93.5%Language:HTML 3.2%Language:JavaScript 2.2%Language:CSS 1.1%