README.md

Best Web Firms

Deployed Sites

• Go to Development Site
• Go to Production Site

Deployed Artifacts

• Development Docker Image: Published on each merge to master.
• Production Docker Image: Published on each merge to master with commit msg containing keyword [release].

Unit Testing Coverage report

Go to Coveralls.io

CI/CD Pipeline

What's it

This is a Single Page Application (SPA) built with Create React App, Redux and Material-UI.

The code is organized following an intuitive architecture and follows some of the best practices in React & JavaScript world, the following features are included in this code baseline:

• Mock System: All endpoints are mocked, so the app can run without being connected to a backend.
• Internationalization: All texts are localized, so the app support multiple languages.
• Redux Architecture: Organized in Action Creators, Reducers and Containers.
• Component Oriented Architecture: Organized in Containers, Pages, Navigation Controls and Common Controls.
• Environments: Support for multiple environments including Local, Dev, QA, Staging and Prod.
• Security System: Including Login, Password Recovery, User Management and Bearer Tokens.
• Built-in controls: Including Accordion, Autocomplete, Avatar, Checkfield, Datepicker, Multi Select, Modal Dialog, Select, Switch, Table, Textfield and Treeview.
• Master Data System: Including Main Menu, Footer, Profile Menu, Auto Spinner for ajax calls, Confirm Dialog and Toast Notifications.
• Common Pages: Including Settings, Home Page, Log Viewer, Master Data, Not Found Page, Roles and Users.
• Ajax Interceptors: To globally process requests and responses, send bearer tokens and handle errors.
• Utilities: Including Arrays, Dates, Language, Numbers, Objects, Strings and Validations.
• Linters: Including CSS and Javascript
• Unit testing: Including tests for Action Creators, Reducers and Utilities.
• Styles: Supporting SASS, JSS and CSS.

Environment Setup

1. Install Node.js

• Download

2. Install Git

• Git Client
• Source Tree (Optional)

3. Clone Repository

git clone https://github.com/celerik/best-web-firms-react.git

4. Install Visual Studio Code & Extensions

• Visual Studio Code

Extensions:

• ESLint
• EditorConfig
• GitLens
• Jest
• Icons
• NpmIntellisense
• SortLines

Run Project

1. Install packages: npm install
2. Build CSS files: npm run build-css
3. Run JavaScript linter: npm run lintj
4. Run CSS linter: npm run lints
5. Run unit tests: npm run test
6. Generate documentation: npm run doc
7. Start project: npm start

Documentation

• Check out Component's documentation here.

What's next

Check out the road map of best-web-firms-react here.

License

best-web-firms is licensed under the MIT license.

How to Contribute

Check out the contributing guide here.