0.0.1 • Published 9 months ago
doct-core v0.0.1
README
This README would normally document whatever steps are necessary to get your application up and running.
What is this repository for?
- Quick summary
- Version
- Learn Markdown
How do I get set up?
- Summary of set up
- Configuration
- Dependencies
- Database configuration
- How to run tests
- Deployment instructions
Contribution guidelines
- Writing tests
- Code review
- Other guidelines
Who do I talk to?
- Repo owner or admin
- Other community or team contact
Components
| Name | Logical Name | Description | Status |
|---|---|---|---|
| Container | DoctContainer | For the layout of app. | Ready |
| Row | DoctRow | For the layout of app. | Ready |
| Col | DoctCol | For the layout of app. | Ready |
| Typography | DoctTypography | Typography will be used as a html tag for content | Ready |
| Docthub Logo | DoctLogo | Logo is representation of a brand | Ready |
| Docthub Logo TM | DoctLogoTM | Logo is representation of a brand with TM symbol | Ready |
| Icons | DoctIcon | An icon is a small image, usually a symbol, used to graphically represent a software program, file, or function on a computer screen. | Ready | | Avatar | DoctAvatar | An avatar is the embodiment of a person or idea. | Ready | | Button | DoctButton | Buttons allow users to take actions, and make choices, with a single tap. | Ready | | Icon Button | DoctIconButton | Buttons allow users to take actions, and make choices, with a single tap. | Ready |
Functions
| Name | Logical Name | Description | Status |
|---|---|---|---|
| Cross Storage | CrossStorage | To Connect with CrossStorage | Ready |
| logOut | OnLogOut | To Logout users from CrossStorage and clear user info from the localstorage | Ready |
| Google Analytics | DoctGoogleAnalytics | Google Analytics is easy to figure out for even the greenest of new website owners and it provides you with loads of valuable information. | Ready |
Utility Classes
| Name | Description |
|---|---|
| m-0, p-0 | margin and padding 0 and it's auto classess |
| d-flex | all kind of flex classes with responsive |
| text-center | all kind of text align classes with responsive |
| position-relative | all kind of position classes with responsive |
| height and width | 25%, 50%, 75%, 100% width and height classes with responsive |
| bg-primary | #00A0C0 |
| bg-primary-100 | #CDECF1 |
| bg-primary-200 | #99D9E3 |
| bg-primary-300 | #67C6D8 |
| bg-primary-400 | #32B3C9 |
| bg-primary-500 | #0091AF |
| bg-primary-600 | #007890 |
| bg-primary-700 | #01505F |
| bg-primary-800 | #002830 |
| bg-grey-100 | #F9F9F9 |
| bg-grey-200 | #F4F4F4 |
| bg-grey-300 | #E3E3E3 |
| bg-grey-400 | #AAAAAA |
| bg-grey-500 | #8E8E8E |
| bg-grey-600 | #717171 |
| bg-grey-700 | #4B4B4B |
| bg-grey-800 | #242424 |
| text-primary | #00A0C0 |
| text-primary-100 | #CDECF1 |
| text-primary-200 | #99D9E3 |
| text-primary-300 | #67C6D8 |
| text-primary-400 | #32B3C9 |
| text-primary-500 | #0091AF |
| text-primary-600 | #007890 |
| text-primary-700 | #01505F |
| text-primary-800 | #002830 |
| text-grey-100 | #F9F9F9 |
| text-grey-200 | #F4F4F4 |
| text-grey-300 | #E3E3E3 |
| text-grey-400 | #AAAAAA |
| text-grey-500 | #8E8E8E |
| text-grey-600 | #717171 |
| text-grey-700 | #4B4B4B |
| text-grey-800 | #242424 |
0.0.1
9 months ago