This project was bootstrapped with Create React App and later migrated to NextJS
For development, you will need Node.js and Yarn package manager installed on your environment.
If you are using a Mac, you can install Yarn through Homebrew package manager. This will also install Node.js if not already installed.
brew install yarn
In the project directory, run:
yarn install
In the project directory, run:
yarn run dev
yarn run build
./next
folderyarn run start
Deploys are triggered automatically by pushing to the master
or dev
branches.
This project uses a feature branch based workflow.
New features should be developed on new feature branches named in the following format: [username]/[fancy-branch-name]
.
Pull requests should be sent to the dev
branch for code review.
Merges into master
happen at the end of sprints, and tags in master correspond to production releases.
This project is using React as a frontend framework coupled with Redux for state management.
Also it get's server rendered with NextJS.
We use Prettier, an opinionated code formatter, for JS code formatting. Whenever a commit is made, Prettier will automatically format the changed files. Prettier can also be integrated into many text editors.
Our executive dashboard is used for monitoring the health and state of our system. The dashboard can be viewed at the /dashboard
route of the frontend.
If you have the refine.bio backend running locally, just run the script with the variable REACT_APP_API_HOST
pointing to the local API. For example:
REACT_APP_API_HOST=http://localhost:8000 yarn run dev