README.md

Workshare (Backend Side)

Workshare is a website where people can share their project ideas. We built Workshare during the Hack Your Portfolio Hackathon by MLH.

Authors

• @guettafa
• @AchrafGroiez
• @QuocDungTran380

Important links

• Devpost Submission
• Frontend

Features

• Find projects by content and tags.
• Create a project idea.
• Login and register.

Technologies

Frontend

• Typescript
• React
• Next.js
• Axios
• MUI

Backend

• Java
• Spring Boot
• Maven
• Lombok

Installation

External dependencies

• nodejs
• MariaDB
• JDK 17

Frontend

Setup :

git clone https://github.com/2GTM/workshare-frontend
cd workshare-frontend/
npm install

Create a file named config.json in the root directory with the following content :

{
  "backendUrl" : "$BACKEND_URL"
}

Backend

Setup :

git clone https://github.com/2GTM/workshare-backend
cd workshare-backend
mvn install

Create a file named env.properties in the root directory with the following content :

# Server port
PORT=

# Database information
URL=jdbc:mariadb://localhost:3306/workshare
DB_USERNAME=
DB_PASSWORD=

# Frontend URL
ALLOWED_URL=

# Secret key for JWT.
SECRET_JWT_KEY=

Run the project

# Frontend
npm run dev

# Backend
mvn spring-boot:run

Preview

Home

Login

Search project

Create project

Project view

Trending

User profile