coreable / coreable

coreable

COREABLE

Getting Started

1. Clone the project
2. Install project dependencies
3. Create your own branch and begin hacking

terminal

git clone https://github.com/coreable/coreable.git
cd coreable
npm install

Creating a local MySQL instance for development

While developing and working on the coreable API or Web SPA it may be necessary to start an instance of MySQL server to avoid remote connections to the cloud. Running the API in development mode will use the database settings specified in the development object of the /api/env/development.env file.

Make sure the credentials in the /api/env/development.env correctly match the credentials in the /docker-compose.yml file in the root directory.

To begin a MySQL server, open the terminal and being a docker container with docker-compose up -d. This will use the docker-compose.yml file as a configuration to being the database service.

NOTE: Docker must be installed.

terminal

cd coreable
docker-compose up -d

The database is ready for connection.

Building for Development

API

npm run dev:api

React

npm run dev:web

Documentation

npm run dev:docz

Building for Production

API

npm run build:api

This will compile all the files in the /api/ directory, excluding the mocha & chai tests, to the output directory of /dist/.

React

npm run build:web

This will compile all the files in the /react/src/ and /react/public directory, excluding the tests, to the output directory of /dist/public.

Documentation

npm run build:docz

This will compile all the files in the /docs/ directory to the output directory of /dist/docs.

Running Unit Tests

API

npm run test:api

React

npm run test:web

Documentation

Docz don't need testing

Fix node-gyp or fsevents

https://github.com/nodejs/node-gyp/blob/master/macOS_Catalina.md