Committed project

• Committed project
  • Introduction
  • Description
  • Getting started
    • Prerequisites
    • Set-up DB
    • Run it
      • Using IntelliJ
        • Start Backend
        • Start Frontend
      • Using shell
        • Start Backend
        • Start Frontend
    • Try it
  • My Contributions
  • CircleCI Dashboard

Introduction

This project was created by me and three other students during the last month of a bootcamp.

The app was deployed to multiple environments on cloud but is currently offline.

Description

Todo app. Created with Spring API and React frontend.

Getting started

Prerequisites

• MySQL DB
• IntelliJ IDEA or npm and NGINX

Set-up DB

• set up MySQL DB according to the following table:

property	value
address	localhost:3306
database name	committed_app
user	root
password	password

Tip

You can use different values and override them later in the set-up

Run it

Using IntelliJ

Start Backend

1. Open project (File > Open..) form the backend directory
2. cp .env.sample .env

Tip

You can now override the DB credentials inside .env

3. Using the IntelliJ's Run Configurations run the default configuration (or run the com/gfa/ProjectApplication.java file)

Start Frontend

1. Open project (File > Open..) form the frontend directory
2. cp .env.sample .env
3. Using the IntelliJ's Run Configurations run the npm start configuration

Note

You might need to create it first. Don't forgot to specify the package.json filepath (you can find it in the frontend directory)

4. Try it

Using shell

Start Backend

Starting from the Git repository root:

1. cd backend
2. cp .env.sample .env

Tip

You can now override the DB credentials inside .env

3. ./gradlew bootRun

Start Frontend

Starting from the Git repository root:

1. cd frontend directory (parent of this README.md file) if not already
2. npm install
3. set environmental variable corresponding to the backend address export REACT_APP_API_URL="http://localhost:8080/"
4. npm run build
5. cp -r build/ /opt/homebrew/var/www/

Warning

Will override (default) files!

6. cp -r build/ /opt/homebrew/var/www/
7. nginx -c $(pwd)/nginx/config

Try it

1. check it here
2. register and login

Note

It's mostly mock template, but you can create some todos

My Contributions

• Spring Security with JWT
• DB migrations with Flyway
• i18n and l10n
• testing with Junit and Postman
• CI/CD pipeline with CircleCI
• deployment to AWS as jar or Docker image
• documentation

CircleCI Dashboard