@mx-cartographer/experiences

React Library Application Template

This template is used to create projects in the Cartographer group

Getting started

In order to run the project you will need to make sure that you have and yarn installed. It must be higher than 1.22 in order to do that you must have corepack enabled. Do not just run "npm i" all packages must be installed with yarn.

1. Enter into the terminal corepack enable
2. Run the command npm install yarn in the terminal
3. Now run yarn install
4. To start the project run npm run dev (The project should automatically run in the browser)

Creating a project from the template

1. Go to the Cartographer group and click "New Project"
2. Click "Create from Template"
3. Open the "Groups" tab
4. Click "Use Template" in the React Library Application row
5. Enter the project name and ensure that the visitibliy is set to internal. Add a description if needed
6. Click "Create project" and you've created your project

Next steps

Protect the Master branch

Note: A maintainer or owner will need to do this part

1. Open Settings > Repository for the repo
2. Expand the "Selected branches" section
3. For the master branch, set the "Allowed to merge" option to "Developers + Maintainers" and the "Allowed to push" option to "No one"

Merge Request Approvals

1. Open Settings > General for the repo
2. Expand the "Merge request approvals section"
3. Change approvals required to 1

Issue board

Under Issues > Boards, create a new board to track issues for that specific repo. Copy the labels/lists from the scoped issue board in the Cartographer group to create this one. The labels will be the same, but the new issue board will only shows issues created for this specific repo.