Giter VIP home page Giter VIP logo

glue-stack's Introduction

Glue Stack

A multi-tenant, multi-user todo application where organisations can sign up and manage their users' tasks.

Screeshot

Why

  • A modern Relational, Java, React example application
  • Solve a problem common to a lot of businesses (who might pay you)
  • A small, living codebase where I can contribute and demonstrate my ideas
  • Documentation for professional application development that can teach beginners
  • Put together some of my favourite tools
  • Make a mobile friendly application

Concepts

  • In-Depth Development documentation
  • Authentication
  • Create, List and Edit flow
  • Sorting and Pagination
  • Mobile Friendly
  • Multi-tenancy: Allowing multiple organisations to share a common appication and database in SaaS style

Tools

  • Database
    • MySQL
  • API
    • Java
    • Spring-Boot
    • Spring-Data-JPA
    • Hibernate
    • Spring-Security
  • UI
    • React
    • Create-react-app
    • React-Router-V4
    • Material-UI
  • Version Control
    • Git
    • Git Town
  • Editors
    • Visual Studio Code (vscode)
    • Sequel Pro

Getting Started

Unfortunately, I don't have a live demo yet but I do have a bash script to make getting started fast.

Mac Instructions

  1. Open Terminal (CMD + Space, type Terminal)
  2. Create or just cd into your development folder
    cd ~
    mkdir development
    cd development
    
  3. Checkout this repository
    git clone https://github.com/cadc/glue-stack.git
    cd glue-stack
    
  4. Run the setup bash script
    sh setup.sh
    
    You can open the bash script to find out but it:
    • installs Homebrew
    • installs MySQL
      • creates a database called Glue
    • installs Maven
    • installs Node
    • installs Yarn
  5. Create a new terminal tab (CMD + t)
  6. The first tab will run the api (backend).
    cd api
    mvn spring-boot:run
    
    This will start our Spring Boot Java application which will setup the tables in our database using a tool called Flyway.
  7. The second tab will run our ui (frontend) development server. You won't need this in production.
    cd ui
    yarn
    yarn start
    
    This will open a browser window to our application. Make sure both servers are started before your start playing with it.
  8. Signup your organisation!

Development Environment Setup

  1. Sequel Pro (Database)
    1. Download Sequel Pro
    2. Install Sequel Pro
    3. Open Sequel Pro
    4. Select Socket as the Connection type
    5. Name: localhost
    6. Username: root
    7. Test Connection
    8. Save as Favorites
    9. Connect
    10. Select the Glue database on the top left dropdown
    11. Have a look around
  2. Visual Studio Code (vscode)
    1. Download vscode
    2. Download these extensions
      1. Java Extension Pack
      2. Git History (git log)
      3. Prettier
      4. Reactjs code snippets
    3. Optional but recommended
      1. Markdown All in One
      2. vscode-icons
      3. Fira Code font for font ligatures
        1. go to https://github.com/tonsky/FiraCode#solution
        2. click download
        3. extract the zip
        4. open the ttf folder
        5. select all the fonts then right click and select open
    4. Settings (CMD + ,)
      {
          "editor.minimap.enabled": false,
          "editor.fontFamily": "Fira Code",
          "editor.fontLigatures": true,
          "editor.fontSize": 14,
          "git.confirmSync": false,
          "workbench.iconTheme": "vscode-icons",
          "editor.formatOnSave": true,
          "git.enableSmartCommit": true,
      }
      

glue-stack's People

Contributors

cadbox1 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.