This project was created using create-react-app.

Perform the following steps to get started:

1. Run npm install or yarn install to install dependencies.
2. Run npm start or yarn start to start the development server.

- src
    - api
    - components
        - elements
        - layout
    - images
    - pages
    - redux
    - App.js
    - index.js
- .eslintrc
- .prettierrc
- jsconfig.json
- package.json
- README.md

Pages: Contains all the pages of the application.

Components: Contains all the components of the application.

Images: Contains all the static images of the application.

The rest are self explanatory.

Some of the libraries used in this project are listed below:

• react-redux
• redux-persist
• MUI
• @octokit
• ESLint
• Prettier

The other packages can be found in the package.json file.

To find more information about the libraries used, please visit their respective GitHub repositories.

ESLint config can be found in the .eslintrc file

• eslint-plugin-prettier: To disable conflicts with Prettier
• eslint-plugin-sort-destructure-keys: To sort the keys of destructured objects
• eslint-plugin-import: Custom sorting of import statements

Prettier config can be found in the .prettierrc file

{
    "tabWidth": 2,
    "useTabs": true,
    "trailingComma": "all",
    "arrowParens": "always",
    "bracketSpacing": true,
    "singleQuote": true,
    "jsxSingleQuote": true,
    "endOfLine": "lf",
    "printWidth": 80
}

A jsconfig.json file is created to set the base url for the imports.

{
  "compilerOptions": {
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "baseUrl": "src"
  }
}

Any pushed made to the master branch will be deployed to the gh-pages branch through GitHub Actions Flow. The configuration can be found in the .github/workflows/main.yml file.