IDEELL SOCIAL MEDIA

This is root folder for Ideell's all services. Short description for subfolders

• api - Spring Boot REST API using JSON. Security with JWT provided by Auth0
• db - Local database folder for testing
• doc - Documentation including graphic profile
• www - 4 separate projects (Ideell start page and PWA apps for Vi, Konst, Kvitter)

Local Setup

Try the following short description of how to start your local environment

Prerequirements

Install

• Java 15
• Docker Compose
• Intellij or Eclipse (install Lombok and Spring Tools 4 for Eclipse)
• Maven
• Npm

Code

1. Clone repo at https://github.com/AIMMOTH/ideell
2. Import Maven project
3. Create project for Ideell start page, Vi, Konst and Kvitter
4. Install Angular CLI in Vi, Konst and Kvitter (npm install -g @angular/cli)

Run Locally

1. Start MongoDB and MariaDB with Docker Compose (docker compose up). This will create folder db
2. Run you selected app with Angular Cli (ng serve)
3. Start Ideell API with either Maven (mvn spring:boot run) or your IDE

Deploy

1. Copy start page into api/src/main/resources/static
2. Build Vi/Konst/Kvitter (ng --prod build)
3. Copy Vi/Konst/Kvitter build into api/src/main/resources/{app}
4. Make Backend build (mvn package)
5. Login to ElastX
6. Select correct environment
7. Upload build JAR-file (found in api/target)

Contribution guidelines

• If you touch code, try to clean up and make it look better than before you started
• If you create something new, use a well known name for main logic and package with same name for smaller objects

What to work with

Use the following priority

1. Merge your PRs that are accepted
2. Check for PRs to review
3. Continue your features
4. Check for selected issues that are specified well enough for you to start work with

Halp!

You can contact Aimmoth@github