Introduction

React Project Starter Framework - Bootstrap a new React web applications without any hassle. Check out the complete documentation HERE.

Technologies used: React.js | Next.js | TypeScript | Redux Toolkit | RTK Query | Tailwind | Prettier | ESLint | React Hook Form | DayJS | Yarn | Docker |

Prerequisites

1. Node.js version greater than or equals to 18.17 - it is recommended to use Node.js 20.10.0 LTS.
2. Installed Node.js should be 64bit (x64) version.
3. If you need older Node.js versions for other projects, please use NVM to make changing versions easier.
4. You should have access to the SSL React Framework Bitbucket Repo.
5. Personal SSH Key have to configured to access Bitbucket repositories. SSH Setup for Linux | SSH Setup for Windows | SSH Setup for Mac
6. Docker should be installed in your machine. Docker for Windows | Docker for Linux | Docker for Mac
7. Git should be installed and configured correctly.
8. Yarn should be installed. Install Guide
9. These VSCode extensions should be installed: ESLint | Prettier | Import Cost

Installation

At first install the framework directly from NPM Package Manager

npx react-project-starter-ssl

When prompted write your project name

Name: test_project

Open the project directory in your terminal

cd test_project

Open the application with your code editor. It is good to use VSCode.

To run the application enter this command

yarn dev

Your project is now ready!

Default port 3000 will be used. If it is not free then the next port will be used.

How to contribute

You can contribute to the framework and make it better.

1. Create a new branch from the dev branch. Branch name should contain your name or id. Example: dev_muneer.
2. Push to your branch.
3. Create a pull request to merge your branch with the dev branch. How to create Pull Request.
4. Inform the maintainers to accept your PR. If accepted, your branch will be merged to dev.