Skip to main content

Installation

React Starter is a starter project built upon Zengenti's Contensis React Base framework. It's intended purpose is to help kickstart development with Contensis & React.

Requirements​

  • Node.js version 18.0 or above (which can be checked by running node -v)

We recommend using nvm for managing multiple versions of Node.

Installation​

To create and install a new React Starter project, use the following commands:

npx contensis-react-starter my-project
cd my-project
npm install
caution

If you encounter issues when running npm install, try the following:
rm -rf /node_modules && npm i --legacy-peer-deps

Cloning fresh from GitLab​

Alternatively, you can clone the project directly from the GitLab repository. However, you will need to remove and reinitialise Git within the repository:

git clone https://gitlab.zengenti.com/starter-projects/react-starter.git my-project
cd my-project
rm -rf .git
npm install

After installation, you can reinitialise Git with the following commands:

git init
git add .
git commit -m "Initial commit"

Existing Project​

If you are joining an existing project or one created on your behalf by Zengenti, simply clone and install the repository:

git clone https://gitlab.zengenti.com/group-name/my-project-name.git my-project
cd my-project
npm install

Running the development server​

To begin developing locally you'll need to familiarise yourself with these commands:

  • npm start - start the application in development mode (http://localhost:3000/)
  • npm run storybook - start storybook in development mode (http://localhost:6006/)
  • npm run build:server - build the application and start the server-side application from source code (allowing us to connect a debugger and stop on code that is executed server-side) (http://localhost:3001/)

Project structure​