AlliedCrowds / giz-investment-guide

Public repository for the GIZ Investment Guide

Make-It

Guide to Investment for African Entrepreneurs

---

Installation

Clone

Clone this repo to your local machine using

$ git clone https://github.com/AlliedCrowds/giz-investment-guide.git`

Setup

We use yarn to manage make-it package dependencies. To get:

$ brew update
$ brew install yarn

To install dependencies:

$ yarn install

Note: After installation yarn will run the build script to verify the project builds correctly.

---

scripts

to build make-it for development or production:

$ yarn run build:dev
$ yarn run build:prod

to build for development and host with webpack-dev-server with hot reloading:

$ yarn run watch

to remove the development and production builds, or both, from the distribution folder use:

$ yarn run clean:dist:dev
$ yarn run clean:dist:prod
$ yarn run clean:dist

to remove node_modules:

$ yarn run clean:node_modules

to clean all dependency and distribution files:

$ yarn run clean:all

to lint the project use:

$ yarn run lint

to prettify the project use:

$ yarn run prettier

to publish the project to development or production environments use:

$ yarn run publish:dev
$ yarn run publish:prod

to clean, build and then publish the project to development or production environments respectively use:

$ yarn run deploy:dev
$ yarn run deploy:prod

Note: husky runs prettier and eslint as a pre-commit hook.

If you use VSCode with the eslint and prettier extensions, the IDE will auto-formatted and -correct your code when you save a file.