- Clone the project
- Install project dependencies
- Create your own branch and begin hacking
git clone https://github.com/coreable/coreable.git
cd coreable
npm install
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.
cd coreable
docker-compose up -d
The database is ready for connection.
npm run dev:api
npm run dev:web
npm run dev:docz
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/
.
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
.
npm run build:docz
This will compile all the files in the /docs/
directory to the output directory of /dist/docs
.
npm run test:api
npm run test:web
Docz don't need testing
https://github.com/nodejs/node-gyp/blob/master/macOS_Catalina.md