Alkemi-UI-template

This project is a front-end template used by Alkemi to start new projects.

It includes

• a stack of .js library that we use on a daily basis
• an easy starting set-up using docker
• contributing guidelines for new developers

Start front-end projects from this template

1. Change name, version, description, repository, keywords, author, bugs in ./package.json if needed
2. Change the icon in ./public/favicon.ico
3. Change title in <title> tag of ./public/index.html
4. Change short_name, name and possibly theme_color and background_color in ./public/manifest.json
5. Update every line README.md until this line

Stack

This application make active usage of

• create-react-app that packs many utilities
• redux for state management
• react-router v4 for routing
• connected-react-router to connect router to redux state
• material-ui v1 as main visual component library

Start application

Requirements

• docker>=17.0.0
• docker-compose>=1.17.0
• node>=9.0.0
• yarn>=1.6.0

Install application

If not yet done, clone project locally and install node dependencies

git clone <project-url> && cd <project-folder>
yarn install # install node dependencies locally

Start application

docker-compose up # start application in dev mode

Contributing guidelines

Refer to contributing guidelines