TREM-OKR

TREM-OKR is a platform for Tracking, Reporting, Exploring and Managing OKRs.

Installation

TODO write this

Usage

TODO write this

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Development

Required Software

• NodeJS
• MongoDB for the database

Instructions

• Fork this repository in GitHub
• Clone your fork
• Run npm install to install dependencies
• Run npm run serve to run

Recommended Software

• Visual Studio Code for editing
• Postman for emulating API calls

NPM Scripts

• npm run dev to run both client & server project concurrently

• npm run build to build both client & server project to out/

If you want to run server & client separately

• npm run dev:client to run client project.

• npm run dev:server to run server project.

• npm run build:client to build client project.

• npm run build:server to build server project.